Documentation - v1.2.0-alpha.3
Preparing search index...
@microsoft/agents-hosting
Authorization
Interface Authorization
interface
Authorization
{
exchangeToken
(
context
:
TurnContext
,
scopes
:
string
[]
,
authHandlerId
:
string
,
)
:
Promise
<
TokenResponse
>
;
exchangeToken
(
context
:
TurnContext
,
authHandlerId
:
string
,
options
?:
AuthorizationHandlerTokenOptions
,
)
:
Promise
<
TokenResponse
>
;
getToken
(
context
:
TurnContext
,
authHandlerId
:
string
,
)
:
Promise
<
TokenResponse
>
;
onSignInFailure
(
handler
:
(
context
:
TurnContext
,
state
:
TurnState
,
authHandlerId
?:
string
,
errorMessage
?:
string
,
)
=>
Promise
<
void
>
,
)
:
void
;
onSignInSuccess
(
handler
:
(
context
:
TurnContext
,
state
:
TurnState
,
authHandlerId
?:
string
,
)
=>
Promise
<
void
>
,
)
:
void
;
signOut
(
context
:
TurnContext
,
state
:
TurnState
,
authHandlerId
?:
string
,
)
:
Promise
<
void
>
;
}
Index
Methods
exchange
Token
get
Token
on
Sign
In
Failure
on
Sign
In
Success
sign
Out
Methods
exchange
Token
exchangeToken
(
context
:
TurnContext
,
scopes
:
string
[]
,
authHandlerId
:
string
,
)
:
Promise
<
TokenResponse
>
Parameters
context
:
TurnContext
scopes
:
string
[]
authHandlerId
:
string
Returns
Promise
<
TokenResponse
>
exchangeToken
(
context
:
TurnContext
,
authHandlerId
:
string
,
options
?:
AuthorizationHandlerTokenOptions
,
)
:
Promise
<
TokenResponse
>
Parameters
context
:
TurnContext
authHandlerId
:
string
Optional
options
:
AuthorizationHandlerTokenOptions
Returns
Promise
<
TokenResponse
>
get
Token
getToken
(
context
:
TurnContext
,
authHandlerId
:
string
)
:
Promise
<
TokenResponse
>
Parameters
context
:
TurnContext
authHandlerId
:
string
Returns
Promise
<
TokenResponse
>
on
Sign
In
Failure
onSignInFailure
(
handler
:
(
context
:
TurnContext
,
state
:
TurnState
,
authHandlerId
?:
string
,
errorMessage
?:
string
,
)
=>
Promise
<
void
>
,
)
:
void
Parameters
handler
:
(
context
:
TurnContext
,
state
:
TurnState
,
authHandlerId
?:
string
,
errorMessage
?:
string
,
)
=>
Promise
<
void
>
Returns
void
on
Sign
In
Success
onSignInSuccess
(
handler
:
(
context
:
TurnContext
,
state
:
TurnState
,
authHandlerId
?:
string
,
)
=>
Promise
<
void
>
,
)
:
void
Parameters
handler
:
(
context
:
TurnContext
,
state
:
TurnState
,
authHandlerId
?:
string
,
)
=>
Promise
<
void
>
Returns
void
sign
Out
signOut
(
context
:
TurnContext
,
state
:
TurnState
,
authHandlerId
?:
string
,
)
:
Promise
<
void
>
Parameters
context
:
TurnContext
state
:
TurnState
Optional
authHandlerId
:
string
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Methods
exchange
Token
get
Token
on
Sign
In
Failure
on
Sign
In
Success
sign
Out
Documentation - v1.2.0-alpha.3
Loading...