EOS_Connect_AddNotifyAuthExpiration

EOS API reference page for EOS_Connect_AddNotifyAuthExpiration

阅读时间2分钟

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 NameUsage Information
EOS_HConnect Handle
const EOS_Connect_AddNotifyAuthExpirationOptions* Optionsstructure containing the API version of the callback to use.
void* ClientDataarbitrary data that is passed back to you in the callback.
const EOS_Connect_OnAuthExpirationCallback Notificationa 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 NameUsage Information
const EOS_Connect_AuthExpirationCallbackInfo* DataA EOS_Connect_AuthExpirationCallbackInfo containing the output information and result.