IAuthenticator Interface |
An interface for generic authentication strategies in Cisco Spark. Each authentication strategy
is responsible for providing an accessToken used throughout this SDK.
Namespace: SparkSDK
Assembly: SparkSDK (in SparkSDK.dll) Version: 0.1.0.0 (0.1.0.0)
SyntaxC#
public interface IAuthenticator
The IAuthenticator type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AccessToken |
Returns an access token of this authenticator.
This may involve long-running operations such as service calls,
but may also return immediately. The application should not make assumptions about how quickly this completes.
If the access token could not be retrieved then the completion handler will be called with null.
|
| Authorized |
Gets a value indicating whether this IAuthenticator is authorized.
This may not mean the user has a valid
access token yet, but the authentication strategy should be able to obtain one without
further user interaction.
|
| Deauthorize |
Deauthorizes the current user and clears any persistent state with regards to the current user.
|
| RefreshToken |
Returns an new access token of this authenticator.
This may involve long-running operations such as service calls.
If the access token could not be retrieved then the completion handler will be called with null.
|
RemarksSince: 0.1.0
See Also