-
Notifications
You must be signed in to change notification settings - Fork 6
/
microsoftTeams.authentication.yml
115 lines (115 loc) · 4.46 KB
/
microsoftTeams.authentication.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
### YamlMime:TSPackage
uid: '@microsoft/teams-js.microsoftTeams.authentication'
name: authentication
summary: >-
Namespace to interact with the authentication-specific part of the SDK. *
This object is used for starting or completing authentication flows.
type: module
interfaces:
- '@microsoft/teams-js.microsoftTeams.authentication.AuthenticateParameters'
- '@microsoft/teams-js.microsoftTeams.authentication.AuthTokenRequest'
package: '@microsoft/teams-js'
functions:
- name: authenticate(AuthenticateParameters)
uid: '@microsoft/teams-js.microsoftTeams.authentication.authenticate'
package: '@microsoft/teams-js'
summary: >-
Initiates an authentication request, which opens a new window with the
specified settings.
remarks: ''
isDeprecated: false
syntax:
content: 'function authenticate(authenticateParameters?: AuthenticateParameters)'
parameters:
- id: authenticateParameters
type: >-
@microsoft/teams-js.<xref
uid="@microsoft.teams-js.authentication.AuthenticateParameters" />
description: ''
- name: getAuthToken(AuthTokenRequest)
uid: '@microsoft/teams-js.microsoftTeams.authentication.getAuthToken'
package: '@microsoft/teams-js'
summary: >-
Requests an Azure AD token to be issued on behalf of the app. The token
is acquired from the cache if it is not expired. Otherwise a
request is sent to Azure AD to obtain a new token.
remarks: ''
isDeprecated: false
syntax:
content: 'function getAuthToken(authTokenRequest: AuthTokenRequest)'
parameters:
- id: authTokenRequest
type: >-
@microsoft/teams-js.<xref
uid="@microsoft.teams-js.authentication.AuthTokenRequest" />
description: A set of values that configure the token request.
- name: initialize()
uid: '@microsoft/teams-js.microsoftTeams.authentication.initialize'
package: '@microsoft/teams-js'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: function initialize()
- name: notifyFailure(string, string)
uid: '@microsoft/teams-js.microsoftTeams.authentication.notifyFailure'
package: '@microsoft/teams-js'
summary: >-
Notifies the frame that initiated this authentication request that the
request failed. This function is usable only on the authentication
window. This call causes the authentication window to be
closed.
remarks: ''
isDeprecated: false
syntax:
content: 'function notifyFailure(reason?: string, callbackUrl?: string)'
parameters:
- id: reason
type: string
description: ''
- id: callbackUrl
type: string
description: >-
Specifies the url to redirect back to if the client is Win32
Outlook.
- name: notifySuccess(string, string)
uid: '@microsoft/teams-js.microsoftTeams.authentication.notifySuccess'
package: '@microsoft/teams-js'
summary: >-
Notifies the frame that initiated this authentication request that the
request was successful. This function is usable only on the
authentication window. This call causes the authentication window
to be closed.
remarks: ''
isDeprecated: false
syntax:
content: 'function notifySuccess(result?: string, callbackUrl?: string)'
parameters:
- id: result
type: string
description: >-
Specifies a result for the authentication. If specified, the frame
that initiated the authentication pop-up receives this value in its
callback.
- id: callbackUrl
type: string
description: >-
Specifies the url to redirect back to if the client is Win32
Outlook.
- name: registerAuthenticationHandlers(AuthenticateParameters)
uid: >-
@microsoft/teams-js.microsoftTeams.authentication.registerAuthenticationHandlers
package: '@microsoft/teams-js'
summary: 'Registers the authentication Communication.handlers'
remarks: ''
isDeprecated: false
syntax:
content: >-
function registerAuthenticationHandlers(authenticateParameters:
AuthenticateParameters)
parameters:
- id: authenticateParameters
type: >-
@microsoft/teams-js.<xref
uid="@microsoft.teams-js.authentication.AuthenticateParameters" />
description: A set of values that configure the authentication pop-up.