This function is part of the Auth Interface.
Remarks
Deletes a previously received and locally stored persistent auth access token for the currently logged in user of the local device. On Desktop and Mobile platforms, the access token is deleted from the keychain of the local user and a backend request is made to revoke the token on the authentication server. On Console platforms, even though the caller is responsible for storing and deleting the access token on the local device, this function should still be called with the access token before its deletion to make the best effort in attempting to also revoke it on the authentication server. If the function would fail on Console, the caller should still proceed as normal to delete the access token locally as intended.
Parameters
EOS_Auth_DeletePersistentAuth
Parameter Type And Name | Usage Information |
---|---|
EOS_HAuth Handle | |
const EOS_Auth_DeletePersistentAuthOptions* Options | structure containing operation input parameters |
void* ClientData | arbitrary data that is passed back to you in the CompletionDelegate |
const EOS_Auth_OnDeletePersistentAuthCallback CompletionDelegate | a callback that is fired when the deletion operation completes, either successfully or in error |
Callback Function Information
Because this function is asynchronous, it employs a callback of type EOS_Auth_OnDeletePersistentAuthCallback to report the results of its operation.
Callback Remarks
Function prototype definition for callbacks passed to EOS_Auth_DeletePersistentAuth
Callback Parameters
EOS_Auth_OnDeletePersistentAuthCallback
Parameter Type And Name | Usage Information |
---|---|
const EOS_Auth_DeletePersistentAuthCallbackInfo* Data | A EOS_Auth_DeletePersistentAuthCallbackInfo containing the output information and result |