Class OpenidUserRoutes

The routes for the Dropbox.Api.Openid namespace

Inheritance

object

OpenidUserRoutes

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Dropbox.Api.Openid.Routes

Assembly: Dropbox.Api.dll

Syntax

public class OpenidUserRoutes

Methods

BeginUserinfo(UserInfoArgs, AsyncCallback, object)

Begins an asynchronous send to the userinfo route.

Declaration

public IAsyncResult BeginUserinfo(UserInfoArgs userInfoArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UserInfoArgs	userInfoArgs	The request parameters.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

EndUserinfo(IAsyncResult)

Waits for the pending asynchronous send to the userinfo route to complete

Declaration

public UserInfoResult EndUserinfo(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
UserInfoResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UserInfoError.

UserinfoAsync(UserInfoArgs)

This route is used for refreshing the info that is found in the id_token during the OIDC flow. This route doesn't require any arguments and will use the scopes approved for the given access token.

Declaration

public Task<UserInfoResult> UserinfoAsync(UserInfoArgs userInfoArgs)

Parameters

Type	Name	Description
UserInfoArgs	userInfoArgs	The request parameters

Returns

Type	Description
Task<UserInfoResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UserInfoError.