Interface TokenResources
- Namespace
- Smartsheet.Api
- Assembly
- smartsheet-csharp-sdk.dll
This interface provides methods to access Token resources.
Thread Safety: Implementation of this interface must be thread safe.
public interface TokenResources
Methods
GetAccessToken()
Please use OAuthFlowBuilder class to build an instance of an OAuthFlow class.
Will throw a NotSupportedException.
It mirrors to the following Smartsheet REST API method: POST /token
void GetAccessToken()
Exceptions
- NotSupportedException
This exception is always thrown since this operation is not supported by the Token Resources. Instead, see OAuthFlow.
RefreshAccessToken()
Please use OAuthFlowBuilder class to build an instance of an OAuthFlow class.
Will throw a NotSupportedException.
It mirrors to the following Smartsheet REST API method: POST /token
void RefreshAccessToken()
Exceptions
- NotSupportedException
This exception is always thrown since this operation is not supported by the Token Resources. Instead, see OAuthFlow.
RevokeAccessToken(bool?)
Revokes the access token used to make this request. The access token will no longer be valid, and subsequent API calls made using the token will fail.
It mirrors to the following Smartsheet REST API method:
DELETE /token
void RevokeAccessToken(bool? deleteAllForApiClient = null)
Parameters
deleteAllForApiClient
bool?
Exceptions
- InvalidOperationException
if any argument is null or empty string
- InvalidRequestException
if there is any problem with the REST API request
- AuthorizationException
if there is any problem with the REST API authorization (access token)
- ResourceNotFoundException
if the resource cannot be found
- ServiceUnavailableException
if the REST API service is not available (possibly due to rate limiting)
- SmartsheetException
if there is any other error during the operation