BaseValidatingTicketContext<TOptions> Class

 

Base class used for certain event contexts

Namespace:   Microsoft.Owin.Security.OAuth
Assembly:  Microsoft.Owin.Security.OAuth (in Microsoft.Owin.Security.OAuth.dll)

Inheritance Hierarchy

System.Object
  Microsoft.Owin.Security.Provider.BaseContext<TOptions>
    Microsoft.Owin.Security.OAuth.BaseValidatingContext<TOptions>
      Microsoft.Owin.Security.OAuth.BaseValidatingTicketContext<TOptions>
        Microsoft.Owin.Security.OAuth.OAuthGrantAuthorizationCodeContext
        Microsoft.Owin.Security.OAuth.OAuthGrantClientCredentialsContext
        Microsoft.Owin.Security.OAuth.OAuthGrantCustomExtensionContext
        Microsoft.Owin.Security.OAuth.OAuthGrantRefreshTokenContext
        Microsoft.Owin.Security.OAuth.OAuthGrantResourceOwnerCredentialsContext
        Microsoft.Owin.Security.OAuth.OAuthValidateIdentityContext

Syntax

public abstract class BaseValidatingTicketContext<TOptions> : BaseValidatingContext<TOptions>
generic<typename TOptions>
public ref class BaseValidatingTicketContext abstract : BaseValidatingContext<TOptions>
[<AbstractClass>]
type BaseValidatingTicketContext<'TOptions> = 
    class
        inherit BaseValidatingContext<'TOptions>
    end
Public MustInherit Class BaseValidatingTicketContext(Of TOptions)
    Inherits BaseValidatingContext(Of TOptions)

Type Parameters

  • TOptions

Constructors

Name Description
System_CAPS_protmethod BaseValidatingTicketContext<TOptions>(IOwinContext, TOptions, AuthenticationTicket)

Initializes base class used for certain event contexts

Properties

Name Description
System_CAPS_pubproperty Error

The error argument provided when SetError was called on this context. This is eventually returned to the client app as the OAuth "error" parameter.(Inherited from BaseValidatingContext<TOptions>.)

System_CAPS_pubproperty ErrorDescription

The optional errorDescription argument provided when SetError was called on this context. This is eventually returned to the client app as the OAuth "error_description" parameter.(Inherited from BaseValidatingContext<TOptions>.)

System_CAPS_pubproperty ErrorUri

The optional errorUri argument provided when SetError was called on this context. This is eventually returned to the client app as the OAuth "error_uri" parameter.(Inherited from BaseValidatingContext<TOptions>.)

System_CAPS_pubproperty HasError

True if application code has called any of the SetError methods on this context.(Inherited from BaseValidatingContext<TOptions>.)

System_CAPS_pubproperty IsValidated

True if application code has called any of the Validate methods on this context.(Inherited from BaseValidatingContext<TOptions>.)

System_CAPS_pubproperty Options

(Inherited from BaseContext<TOptions>.)

System_CAPS_pubproperty OwinContext

(Inherited from BaseContext<TOptions>.)

System_CAPS_pubproperty Request

(Inherited from BaseContext<TOptions>.)

System_CAPS_pubproperty Response

(Inherited from BaseContext<TOptions>.)

System_CAPS_pubproperty Ticket

Contains the identity and properties for the application to authenticate. If the Validated method is invoked with an AuthenticationTicket or ClaimsIdentity argument, that new value is assigned to this property in addition to changing IsValidated to true.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod Rejected()

Marks this context as not validated by the application. IsValidated and HasError become false as a result of calling.(Inherited from BaseValidatingContext<TOptions>.)

System_CAPS_pubmethod SetError(String)

Marks this context as not validated by the application and assigns various error information properties. HasError becomes true and IsValidated becomes false as a result of calling.(Inherited from BaseValidatingContext<TOptions>.)

System_CAPS_pubmethod SetError(String, String)

Marks this context as not validated by the application and assigns various error information properties. HasError becomes true and IsValidated becomes false as a result of calling.(Inherited from BaseValidatingContext<TOptions>.)

System_CAPS_pubmethod SetError(String, String, String)

Marks this context as not validated by the application and assigns various error information properties. HasError becomes true and IsValidated becomes false as a result of calling.(Inherited from BaseValidatingContext<TOptions>.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

System_CAPS_pubmethod Validated()

Marks this context as validated by the application. IsValidated becomes true and HasError becomes false as a result of calling.(Inherited from BaseValidatingContext<TOptions>.)

System_CAPS_pubmethod Validated(AuthenticationTicket)

Replaces the ticket information on this context and marks it as as validated by the application. IsValidated becomes true and HasError becomes false as a result of calling.

System_CAPS_pubmethod Validated(ClaimsIdentity)

Alters the ticket information on this context and marks it as as validated by the application. IsValidated becomes true and HasError becomes false as a result of calling.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.Owin.Security.OAuth Namespace

Return to top