NoInteractionHandler Class Reference

Handler for the case where an authorization request should be processed without user interaction. More...

Inheritance diagram for NoInteractionHandler:

Public Member Functions
	NoInteractionHandler (IAuthleteApi api, INoInteractionHandlerSpi spi)
	Constructor. More...
async Task< HttpResponseMessage >	Handle (AuthorizationResponse response)
	Handle an authorization request without user interaction. This method calls Authlete's /api/auth/authorization/issue API or /api/auth/authorization/fail API. More...
Public Member Functions inherited from AuthorizationRequestBaseHandler
	AuthorizationRequestBaseHandler (IAuthleteApi api)
	Consturctor with an implementation of the IAuthleteApi interface which will be passed to the constructor of the super class. More...
Public Member Functions inherited from BaseRequestHandler
	BaseRequestHandler (IAuthleteApi api)
	Constructor with an implementation of the IAuthleteApi interface. The given value can be referred to as the value of the Api property later. More...

Additional Inherited Members
Protected Member Functions inherited from AuthorizationRequestBaseHandler
async Task< HttpResponseMessage >	AuthorizationIssue (string ticket, string subject, long authTime, string acr, IDictionary< string, object > claims, Property[] properties, string[] scopes, string sub)
	Call Authlete's /api/auth/authorization/issue API and generate an HttpResponseMessage instance according to the value of the "action" parameter in the response from the API. Read the description of AuthorizationIssueRequest for details about the parameters given to this method. More...
async Task< HttpResponseMessage >	AuthorizationFail (string ticket, AuthorizationFailReason reason)
	Call Authlete's /api/auth/authorization/fail API and generate an HttpResponseMessage instance according to the value of the "action" parameter in the response from the API. Read the description of AuthorizationFailRequest for details about the parameters given to this method. More...
Protected Member Functions inherited from BaseRequestHandler
HttpResponseMessage	UnknownAction (string apiPath)
	A utility method to generate an HttpResponseMessage instance with "500 Internal Server Error" and an error message in JSON. This method is expected to be used when the value of the "action" parameter in a response from an Authlete API holds an unexpected value. More...
Properties inherited from BaseRequestHandler
IAuthleteApi	Api [get]
	The implementation of the IAuthleteApi interface. It is the value given to the constructor. More...

Detailed Description

Handler for the case where an authorization request should be processed without user interaction.

A response from Authlete's /api/auth/authorization API contains an "action" response parameter. When the value of the response parameter is "NO_INTERACTION", the authorization request needs to be processed without user interaction. This class is a handler for the case.

Constructor & Destructor Documentation

NoInteractionHandler()

NoInteractionHandler ( IAuthleteApi  api, INoInteractionHandlerSpi  spi  )

inline

Constructor.

Parameters

api	An implementation of the IAuthleteApi interface.

Parameters

spi	An implementation of the Service Provider Interface. It is the customization point.

Member Function Documentation

Handle()

async Task<HttpResponseMessage> Handle ( AuthorizationResponse  response )

inline

Handle an authorization request without user interaction. This method calls Authlete's /api/auth/authorization/issue API or /api/auth/authorization/fail API.

Returns

An HTTP response that should be returned to the user agent. If response.Action is not AuthorizationAction.NO_INTERACTION, this method returns null.

Parameters

response

A response from Authlete's /api/auth/authorization API.

Exceptions

AuthleteApiException

---

The documentation for this class was generated from the following file:

• Authlete/Handler/NoInteractionHandler.cs