This function is part of the Connect Interface.
Remarks
Register to receive upcoming authentication expiration notifications. Notification is approximately 10 minutes prior to expiration. Call EOS_Connect_Login again with valid third party credentials to refresh access.
must call RemoveNotifyAuthExpiration to remove the notification.
Return Value
handle representing the registered callback.
Parameters
EOS_Connect_AddNotifyAuthExpiration
Parameter Type And Name | Usage Information |
---|---|
EOS_HConnect Handle | |
const EOS_Connect_AddNotifyAuthExpirationOptions* Options | structure containing the API version of the callback to use. |
void* ClientData | arbitrary data that is passed back to you in the callback. |
const EOS_Connect_OnAuthExpirationCallback Notification | a callback that is fired when the authentication is about to expire. |
Callback Function Information
Because this function is asynchronous, it employs a callback of type EOS_Connect_OnAuthExpirationCallback to report the results of its operation.
Callback Remarks
Function prototype definition for notifications that come from EOS_Connect_AddNotifyAuthExpiration.
Callback Parameters
EOS_Connect_OnAuthExpirationCallback
Parameter Type And Name | Usage Information |
---|---|
const EOS_Connect_AuthExpirationCallbackInfo* Data | A EOS_Connect_AuthExpirationCallbackInfo containing the output information and result. |