EOS API reference page for EOS_RTCAdmin_QueryJoinRoomToken

1 min to read


Query for a list of user tokens for joining a room. Each query generates a query id ( see EOS_RTCAdmin_QueryJoinRoomTokenCompleteCallbackInfo ) which should be used to retrieve the tokens from inside the callback. This query id and query result itself are only valid for the duration of the callback.

Return Value

  • EOS_Success if the operation completes successfully

  • EOS_InvalidParameters if any of the options are incorrect



Parameter Type And NameUsage Information
EOS_HRTCAdmin Handle
const EOS_RTCAdmin_QueryJoinRoomTokenOptions* OptionsStructure containing information about the application whose user tokens we're retrieving.
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate
const EOS_RTCAdmin_OnQueryJoinRoomTokenCompleteCallback CompletionDelegateThis function is called when the query join room token operation completes.