BaseValidatingTicketContext<TOptions> Class

Article
10/29/2013

Base class used for certain event contexts

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

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

Syntax

'Declaration
Public MustInherit Class BaseValidatingTicketContext(Of TOptions) _
    Inherits BaseValidatingContext(Of TOptions)
'Usage
Dim instance As BaseValidatingTicketContext(Of TOptions)

public abstract class BaseValidatingTicketContext<TOptions> : BaseValidatingContext<TOptions>

generic<typename TOptions>
public ref class BaseValidatingTicketContext abstract : public BaseValidatingContext<TOptions>

[<AbstractClassAttribute>]
type BaseValidatingTicketContext<'TOptions> =  
    class 
        inherit BaseValidatingContext<'TOptions>
    end

JScript does not support generic types and methods.

Type Parameters

TOptions

The BaseValidatingTicketContext<TOptions> type exposes the following members.

Constructors

	Name	Description
	BaseValidatingTicketContext<TOptions>	Initializes base class used for certain event contexts

Top

Properties

	Name	Description
	Error	Gets the validation error. (Inherited from BaseValidatingContext<TOptions>.)
	ErrorDescription	Gets the description of the error. (Inherited from BaseValidatingContext<TOptions>.)
	ErrorUri	Gets the Uri error. (Inherited from BaseValidatingContext<TOptions>.)
	HasError	Gets a value that indicates whether the authentication has an error. (Inherited from BaseValidatingContext<TOptions>.)
	IsValidated	Gets a value that indicates whether the context is validated. (Inherited from BaseValidatingContext<TOptions>.)
	Options	(Inherited from BaseContext<TOptions>.)
	OwinContext	(Inherited from BaseContext<TOptions>.)
	Request	(Inherited from BaseContext<TOptions>.)
	Response	(Inherited from BaseContext<TOptions>.)
	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.

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	Rejected	Shows the rejected context after validation. (Inherited from BaseValidatingContext<TOptions>.)
	SetError(String)	Sets error after validation. (Inherited from BaseValidatingContext<TOptions>.)
	SetError(String, String)	Sets error after validation. (Inherited from BaseValidatingContext<TOptions>.)
	SetError(String, String, String)	Sets error after validation. (Inherited from BaseValidatingContext<TOptions>.)
	ToString	(Inherited from Object.)
	Validated()	Occurs when the context is finished validating. (Inherited from BaseValidatingContext<TOptions>.)
	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.
	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.

Top

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.

Share via