DittoSDK.IDittoAuthenticationDelegate Interface Reference

Provides feedback to the developer about Ditto authentication status. More...

Inherited by DittoSDK.NoOpAuthenticationDelegate.

Public Member Functions
void	AuthenticationRequired (DittoAuthenticator authenticator)
	There is no Ditto authentication token or it has expired. Sync will not work until there is a successful login using one of the login methods on DittoAuthenticator. More...
void	AuthenticationExpiringSoon (DittoAuthenticator authenticator, long secondsRemaining)
	Warns that the Ditto authentication token is getting old. More...
void	AuthenticationStatusDidChange (DittoAuthenticator authenticator)
	Notifies the authentication delegate that the authentication status did change. Use the authenticators property Status to query for the current authentication status. More...

Detailed Description

Provides feedback to the developer about Ditto authentication status.

Member Function Documentation

AuthenticationExpiringSoon()

void DittoSDK.IDittoAuthenticationDelegate.AuthenticationExpiringSoon	(	DittoAuthenticator	authenticator,
		long	secondsRemaining
	)

Warns that the Ditto authentication token is getting old.

Ditto will attempt to refresh tokens periodically, starting from halfway through the token's validity period. This reduces the risk of authentication expiring while the user is offline.

The refresh will happen automatically if Ditto has a suitable refresh token. If new credentials are required, such as a third-party token or a username/password, then Ditto does not cache that information and you must submit it again using one of the login methods on DittoAuthenticator.

Parameters

authenticator	Provides access to authentication methods for logging on to Ditto Cloud.
secondsRemaining	The number of seconds remaining until the currently authenticated session will expire.

AuthenticationRequired()

void DittoSDK.IDittoAuthenticationDelegate.AuthenticationRequired

(

DittoAuthenticator

authenticator

)

There is no Ditto authentication token or it has expired. Sync will not work until there is a successful login using one of the login methods on DittoAuthenticator.

Parameters

authenticator

Provides access to authentication methods for logging on to Ditto Cloud.

AuthenticationStatusDidChange()

void DittoSDK.IDittoAuthenticationDelegate.AuthenticationStatusDidChange ( DittoAuthenticator  authenticator )

inline

Notifies the authentication delegate that the authentication status did change. Use the authenticators property Status to query for the current authentication status.

This method is optional, the default implementation does nothing.