Choose your implementation method:
This function is part of the Auth Interface.
Query the backend for an ID token that describes one of the merged account IDs of a local authenticated user.
The ID token can be used to impersonate a merged account ID when communicating with online services.
An ID token for the selected account ID of a locally authenticated user will always be readily available and does not need to be queried explicitly.
Parameters
EOS_Auth_QueryIdToken
|
Parameter Type And Name
|
Usage Information
|
|
EOS_HAuth Handle
|
|
|
const EOS_Auth_QueryIdTokenOptions* Options
|
Structure containing the merged account ID for which to query an ID token.
|
|
void* ClientData
|
Arbitrary data that is passed back to you in the CompletionDelegate.
|
|
const EOS_Auth_OnQueryIdTokenCallback CompletionDelegate
|
A callback that is fired when the operation completes, either successfully or in error.
|
This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the void* parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.
Because this function is asynchronous, it employs a callback of type EOS_Auth_OnQueryIdTokenCallback to report the results of its operation.
Callback Parameters
EOS_Auth_OnQueryIdTokenCallback
This function is part of the Auth Interface.
Query the backend for an ID token that describes one of the merged account IDs of a local authenticated user.
The ID token can be used to impersonate a merged account ID when communicating with online services.
An ID token for the selected account ID of a locally authenticated user will always be readily available and does not need to be queried explicitly.
Parameters
Auth.AuthInterface.QueryIdToken
|
Parameter Type And Name
|
Usage Information
|
|
QueryIdTokenOptions options
|
Structure containing the merged account ID for which to query an ID token.
|
|
object clientData
|
Arbitrary data that is passed back to you in the CompletionDelegate.
|
|
OnQueryIdTokenCallback completionDelegate
|
A callback that is fired when the operation completes, either successfully or in error.
|
This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the object parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.
Because this function is asynchronous, it employs a callback of type Auth.OnQueryIdTokenCallback to report the results of its operation.
Callback Parameters
Auth.OnQueryIdTokenCallback
|
Parameter Type And Name
|
Usage Information
|
|
QueryIdTokenCallbackInfo data
|
Output parameters for the {AuthInterface.QueryIdToken} Function.
|
Was this document useful?
Thank you for the response!
You’ve marked this document as useful:
yes
You’ve marked this document as not useful:
no