通过

Authorization interface

Package:
@microsoft/agents-hosting

Methods

exchangeToken(TurnContext, string, AuthorizationHandlerTokenOptions)
exchangeToken(TurnContext, string[], string)
getToken(TurnContext, string)
onSignInFailure((context: TurnContext, state: TurnState<DefaultConversationState, DefaultUserState>, authHandlerId?: string, errorMessage?: string) => Promise<void>)
onSignInSuccess((context: TurnContext, state: TurnState<DefaultConversationState, DefaultUserState>, authHandlerId?: string) => Promise<void>)
signOut(TurnContext, TurnState<DefaultConversationState, DefaultUserState>, string)

Method Details

exchangeToken(TurnContext, string, AuthorizationHandlerTokenOptions) 

function exchangeToken(context: TurnContext, authHandlerId: string, options?: AuthorizationHandlerTokenOptions): Promise<TokenResponse>

Parameters

context
TurnContext
authHandlerId

string

options

AuthorizationHandlerTokenOptions

Returns

Promise<TokenResponse>

exchangeToken(TurnContext, string[], string) 

function exchangeToken(context: TurnContext, scopes: string[], authHandlerId: string): Promise<TokenResponse>

Parameters

context
TurnContext
scopes

string[]

authHandlerId

string

Returns

Promise<TokenResponse>

getToken(TurnContext, string) 

function getToken(context: TurnContext, authHandlerId: string): Promise<TokenResponse>

Parameters

context
TurnContext
authHandlerId

string

Returns

Promise<TokenResponse>

onSignInFailure((context: TurnContext, state: TurnState<DefaultConversationState, DefaultUserState>, authHandlerId?: string, errorMessage?: string) => Promise<void>) 

function onSignInFailure(handler: (context: TurnContext, state: TurnState<DefaultConversationState, DefaultUserState>, authHandlerId?: string, errorMessage?: string) => Promise<void>)

Parameters

handler

(context: TurnContext, state: TurnState<DefaultConversationState, DefaultUserState>, authHandlerId?: string, errorMessage?: string) => Promise<void>

onSignInSuccess((context: TurnContext, state: TurnState<DefaultConversationState, DefaultUserState>, authHandlerId?: string) => Promise<void>) 

function onSignInSuccess(handler: (context: TurnContext, state: TurnState<DefaultConversationState, DefaultUserState>, authHandlerId?: string) => Promise<void>)

Parameters

handler

(context: TurnContext, state: TurnState<DefaultConversationState, DefaultUserState>, authHandlerId?: string) => Promise<void>

signOut(TurnContext, TurnState<DefaultConversationState, DefaultUserState>, string) 

function signOut(context: TurnContext, state: TurnState<DefaultConversationState, DefaultUserState>, authHandlerId?: string): Promise<void>

Parameters

context
TurnContext
state

TurnState<DefaultConversationState, DefaultUserState>

authHandlerId

string

Returns

Promise<void>