EOS_Connect_AddNotifyAuthExpiration

EOS API reference page for EOS_Connect_AddNotifyAuthExpiration

Choose your implementation method:

C

C#

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.

This function enables your callback (the Notification parameter) to respond to events that happen on the back-end service. Remember to remove your callback function when it is no longer needed.

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.

Related API Members

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 {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

Connect.ConnectInterface.AddNotifyAuthExpiration

Parameter Type And Name

Usage Information

AddNotifyAuthExpirationOptions options

structure containing the API version of the callback to use.

object clientData

arbitrary data that is passed back to you in the callback.

OnAuthExpirationCallback notification

a callback that is fired when the authentication is about to expire.

This function enables your callback (the Notification parameter) to respond to events that happen on the back-end service. Remember to remove your callback function when it is no longer needed.

Callback Function Information

Because this function is asynchronous, it employs a callback of type Connect.OnAuthExpirationCallback to report the results of its operation.

Callback Remarks

Function prototype definition for notifications that come from {ConnectInterface.AddNotifyAuthExpiration}.

Callback Parameters

Connect.OnAuthExpirationCallback

Parameter Type And Name

Usage Information

AuthExpirationCallbackInfo data

A EOS_Connect_AuthExpirationCallbackInfo containing the output information and result.

Related API Members

Tags