BaseValidatingTicketContext<TOptions> Class

Article
10/27/2015

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

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
	BaseValidatingTicketContext<TOptions>(IOwinContext, TOptions, AuthenticationTicket)	Initializes base class used for certain event contexts

Properties

	Name	Description
	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>.)
	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>.)
	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>.)
	HasError	True if application code has called any of the SetError methods on this context.(Inherited from BaseValidatingContext<TOptions>.)
	IsValidated	True if application code has called any of the Validate methods on this context.(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.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	Rejected()	Marks this context as not validated by the application. IsValidated and HasError become false as a result of calling.(Inherited from BaseValidatingContext<TOptions>.)
	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>.)
	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>.)
	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>.)
	ToString()	(Inherited from Object.)
	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>.)
	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.
	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.

Share via