@microsoft/app-manifest 1.0.0-alpha.3db80d0af.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +23 -0
- package/build/ManifestCommonProperties.d.ts +30 -0
- package/build/ManifestCommonProperties.js +5 -0
- package/build/ManifestCommonProperties.js.map +1 -0
- package/build/constants.d.ts +1 -0
- package/build/constants.js +7 -0
- package/build/constants.js.map +1 -0
- package/build/declarativeCopilotManifest.d.ts +68 -0
- package/build/declarativeCopilotManifest.js +15 -0
- package/build/declarativeCopilotManifest.js.map +1 -0
- package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D0.d.ts +163 -0
- package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D0.js +214 -0
- package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D0.js.map +1 -0
- package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D2.d.ts +185 -0
- package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D2.js +220 -0
- package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D2.js.map +1 -0
- package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D3.d.ts +285 -0
- package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D3.js +248 -0
- package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D3.js.map +1 -0
- package/build/generated-types/copilot/plugin/ApiPluginManifestV2D1.d.ts +429 -0
- package/build/generated-types/copilot/plugin/ApiPluginManifestV2D1.js +289 -0
- package/build/generated-types/copilot/plugin/ApiPluginManifestV2D1.js.map +1 -0
- package/build/generated-types/copilot/plugin/ApiPluginManifestV2D2.d.ts +439 -0
- package/build/generated-types/copilot/plugin/ApiPluginManifestV2D2.js +298 -0
- package/build/generated-types/copilot/plugin/ApiPluginManifestV2D2.js.map +1 -0
- package/build/generated-types/index.d.ts +172 -0
- package/build/generated-types/index.js +437 -0
- package/build/generated-types/index.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestV1D0.d.ts +268 -0
- package/build/generated-types/teams/TeamsManifestV1D0.js +265 -0
- package/build/generated-types/teams/TeamsManifestV1D0.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestV1D1.d.ts +268 -0
- package/build/generated-types/teams/TeamsManifestV1D1.js +266 -0
- package/build/generated-types/teams/TeamsManifestV1D1.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestV1D10.d.ts +589 -0
- package/build/generated-types/teams/TeamsManifestV1D10.js +448 -0
- package/build/generated-types/teams/TeamsManifestV1D10.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestV1D11.d.ts +603 -0
- package/build/generated-types/teams/TeamsManifestV1D11.js +447 -0
- package/build/generated-types/teams/TeamsManifestV1D11.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestV1D12.d.ts +638 -0
- package/build/generated-types/teams/TeamsManifestV1D12.js +461 -0
- package/build/generated-types/teams/TeamsManifestV1D12.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestV1D13.d.ts +640 -0
- package/build/generated-types/teams/TeamsManifestV1D13.js +461 -0
- package/build/generated-types/teams/TeamsManifestV1D13.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestV1D14.d.ts +651 -0
- package/build/generated-types/teams/TeamsManifestV1D14.js +467 -0
- package/build/generated-types/teams/TeamsManifestV1D14.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestV1D15.d.ts +656 -0
- package/build/generated-types/teams/TeamsManifestV1D15.js +468 -0
- package/build/generated-types/teams/TeamsManifestV1D15.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestV1D16.d.ts +659 -0
- package/build/generated-types/teams/TeamsManifestV1D16.js +471 -0
- package/build/generated-types/teams/TeamsManifestV1D16.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestV1D17.d.ts +1212 -0
- package/build/generated-types/teams/TeamsManifestV1D17.js +733 -0
- package/build/generated-types/teams/TeamsManifestV1D17.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestV1D19.d.ts +1238 -0
- package/build/generated-types/teams/TeamsManifestV1D19.js +742 -0
- package/build/generated-types/teams/TeamsManifestV1D19.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestV1D2.d.ts +268 -0
- package/build/generated-types/teams/TeamsManifestV1D2.js +266 -0
- package/build/generated-types/teams/TeamsManifestV1D2.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestV1D20.d.ts +1420 -0
- package/build/generated-types/teams/TeamsManifestV1D20.js +818 -0
- package/build/generated-types/teams/TeamsManifestV1D20.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestV1D3.d.ts +280 -0
- package/build/generated-types/teams/TeamsManifestV1D3.js +279 -0
- package/build/generated-types/teams/TeamsManifestV1D3.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestV1D4.d.ts +333 -0
- package/build/generated-types/teams/TeamsManifestV1D4.js +316 -0
- package/build/generated-types/teams/TeamsManifestV1D4.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestV1D5.d.ts +423 -0
- package/build/generated-types/teams/TeamsManifestV1D5.js +357 -0
- package/build/generated-types/teams/TeamsManifestV1D5.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestV1D6.d.ts +428 -0
- package/build/generated-types/teams/TeamsManifestV1D6.js +359 -0
- package/build/generated-types/teams/TeamsManifestV1D6.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestV1D7.d.ts +444 -0
- package/build/generated-types/teams/TeamsManifestV1D7.js +369 -0
- package/build/generated-types/teams/TeamsManifestV1D7.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestV1D8.d.ts +466 -0
- package/build/generated-types/teams/TeamsManifestV1D8.js +386 -0
- package/build/generated-types/teams/TeamsManifestV1D8.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestV1D9.d.ts +532 -0
- package/build/generated-types/teams/TeamsManifestV1D9.js +420 -0
- package/build/generated-types/teams/TeamsManifestV1D9.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestVDevPreview.d.ts +2219 -0
- package/build/generated-types/teams/TeamsManifestVDevPreview.js +1090 -0
- package/build/generated-types/teams/TeamsManifestVDevPreview.js.map +1 -0
- package/build/index.d.ts +88 -0
- package/build/index.js +247 -0
- package/build/index.js.map +1 -0
- package/build/manifest.d.ts +521 -0
- package/build/manifest.js +61 -0
- package/build/manifest.js.map +1 -0
- package/build/pluginManifest.d.ts +143 -0
- package/build/pluginManifest.js +3 -0
- package/build/pluginManifest.js.map +1 -0
- package/build/tsconfig.tsbuildinfo +1 -0
- package/package.json +68 -0
|
@@ -0,0 +1,1238 @@
|
|
|
1
|
+
export interface TeamsManifestV1D19 {
|
|
2
|
+
$schema?: string;
|
|
3
|
+
/**
|
|
4
|
+
* A color to use in conjunction with the icon. The value must be a valid HTML color code
|
|
5
|
+
* starting with '#', for example `#4464ee`.
|
|
6
|
+
*/
|
|
7
|
+
accentColor: string;
|
|
8
|
+
activities?: Activities;
|
|
9
|
+
/**
|
|
10
|
+
* Specify and consolidates authorization related information for the App.
|
|
11
|
+
*/
|
|
12
|
+
authorization?: TeamsManifestV1D19Authorization;
|
|
13
|
+
/**
|
|
14
|
+
* The set of bots for this app. Currently only one bot per app is supported.
|
|
15
|
+
*/
|
|
16
|
+
bots?: Bot[];
|
|
17
|
+
/**
|
|
18
|
+
* The set of compose extensions for this app. Currently only one compose extension per app
|
|
19
|
+
* is supported.
|
|
20
|
+
*/
|
|
21
|
+
composeExtensions?: ComposeExtension[];
|
|
22
|
+
/**
|
|
23
|
+
* A list of tenant configured properties for an app
|
|
24
|
+
*/
|
|
25
|
+
configurableProperties?: ConfigurableProperty[];
|
|
26
|
+
/**
|
|
27
|
+
* These are tabs users can optionally add to their channels and 1:1 or group chats and
|
|
28
|
+
* require extra configuration before they are added. Configurable tabs are not supported in
|
|
29
|
+
* the personal scope. Currently only one configurable tab per app is supported.
|
|
30
|
+
*/
|
|
31
|
+
configurableTabs?: ConfigurableTab[];
|
|
32
|
+
/**
|
|
33
|
+
* The set of Office365 connectors for this app. Currently only one connector per app is
|
|
34
|
+
* supported.
|
|
35
|
+
*/
|
|
36
|
+
connectors?: Connector[];
|
|
37
|
+
copilotAgents?: CopilotAgents;
|
|
38
|
+
/**
|
|
39
|
+
* Defines the list of cards which could be pinned to dashboards that can provide summarized
|
|
40
|
+
* view of information relevant to user.
|
|
41
|
+
*/
|
|
42
|
+
dashboardCards?: DashboardCard[];
|
|
43
|
+
/**
|
|
44
|
+
* A value indicating whether an app is blocked by default until admin allows it
|
|
45
|
+
*/
|
|
46
|
+
defaultBlockUntilAdminAction?: boolean;
|
|
47
|
+
/**
|
|
48
|
+
* When a group install scope is selected, this will define the default capability when the
|
|
49
|
+
* user installs the app
|
|
50
|
+
*/
|
|
51
|
+
defaultGroupCapability?: DefaultGroupCapability;
|
|
52
|
+
/**
|
|
53
|
+
* The install scope defined for this app by default. This will be the option displayed on
|
|
54
|
+
* the button when a user tries to add the app
|
|
55
|
+
*/
|
|
56
|
+
defaultInstallScope?: DefaultInstallScope;
|
|
57
|
+
description: Description;
|
|
58
|
+
developer: Developer;
|
|
59
|
+
/**
|
|
60
|
+
* Specify the native features on a user's device that your app may request access to.
|
|
61
|
+
*/
|
|
62
|
+
devicePermissions?: DevicePermission[];
|
|
63
|
+
extensions?: ElementExtension[];
|
|
64
|
+
/**
|
|
65
|
+
* Specify the app's Graph connector configuration. If this is present then
|
|
66
|
+
* webApplicationInfo.id must also be specified.
|
|
67
|
+
*/
|
|
68
|
+
graphConnector?: GraphConnector;
|
|
69
|
+
icons: Icons;
|
|
70
|
+
/**
|
|
71
|
+
* A unique identifier for this app. This id must be a GUID.
|
|
72
|
+
*/
|
|
73
|
+
id: string;
|
|
74
|
+
/**
|
|
75
|
+
* A value indicating whether a personal app is rendered without a tab header-bar
|
|
76
|
+
*/
|
|
77
|
+
isFullScreen?: boolean;
|
|
78
|
+
localizationInfo?: LocalizationInfo;
|
|
79
|
+
/**
|
|
80
|
+
* The version of the schema this manifest is using. This schema version supports extending
|
|
81
|
+
* Teams apps to other parts of the Microsoft 365 ecosystem. More info at
|
|
82
|
+
* https://aka.ms/extendteamsapps.
|
|
83
|
+
*/
|
|
84
|
+
manifestVersion: "1.19";
|
|
85
|
+
/**
|
|
86
|
+
* Specify meeting extension definition.
|
|
87
|
+
*/
|
|
88
|
+
meetingExtensionDefinition?: MeetingExtensionDefinition;
|
|
89
|
+
name: Name;
|
|
90
|
+
/**
|
|
91
|
+
* Specifies the permissions the app requests from users.
|
|
92
|
+
*/
|
|
93
|
+
permissions?: Permission[];
|
|
94
|
+
/**
|
|
95
|
+
* The url to the page that provides additional app information for the admins
|
|
96
|
+
*/
|
|
97
|
+
publisherDocsUrl?: string;
|
|
98
|
+
/**
|
|
99
|
+
* A value indicating whether or not show loading indicator when app/tab is loading
|
|
100
|
+
*/
|
|
101
|
+
showLoadingIndicator?: boolean;
|
|
102
|
+
/**
|
|
103
|
+
* A set of tabs that may be 'pinned' by default, without the user adding them manually.
|
|
104
|
+
* Static tabs declared in personal scope are always pinned to the app's personal
|
|
105
|
+
* experience. Static tabs do not currently support the 'teams' scope.
|
|
106
|
+
*/
|
|
107
|
+
staticTabs?: StaticTab[];
|
|
108
|
+
/**
|
|
109
|
+
* Subscription offer associated with this app.
|
|
110
|
+
*/
|
|
111
|
+
subscriptionOffer?: SubscriptionOffer;
|
|
112
|
+
/**
|
|
113
|
+
* List of 'non-standard' channel types that the app supports. Note: Channels of standard
|
|
114
|
+
* type are supported by default if the app supports team scope.
|
|
115
|
+
*/
|
|
116
|
+
supportedChannelTypes?: SupportedChannelType[];
|
|
117
|
+
/**
|
|
118
|
+
* A list of valid domains from which the tabs expect to load any content. Domain listings
|
|
119
|
+
* can include wildcards, for example `*.example.com`. If your tab configuration or content
|
|
120
|
+
* UI needs to navigate to any other domain besides the one use for tab configuration, that
|
|
121
|
+
* domain must be specified here.
|
|
122
|
+
*/
|
|
123
|
+
validDomains?: string[];
|
|
124
|
+
/**
|
|
125
|
+
* The version of the app. Changes to your manifest should cause a version change. This
|
|
126
|
+
* version string must follow the semver standard (http://semver.org).
|
|
127
|
+
*/
|
|
128
|
+
version: string;
|
|
129
|
+
/**
|
|
130
|
+
* Specify your AAD App ID and Graph information to help users seamlessly sign into your AAD
|
|
131
|
+
* app.
|
|
132
|
+
*/
|
|
133
|
+
webApplicationInfo?: WebApplicationInfo;
|
|
134
|
+
}
|
|
135
|
+
export interface Activities {
|
|
136
|
+
/**
|
|
137
|
+
* Specify the types of activites that your app can post to a users activity feed
|
|
138
|
+
*/
|
|
139
|
+
activityTypes?: ActivityType[];
|
|
140
|
+
}
|
|
141
|
+
export interface ActivityType {
|
|
142
|
+
description: string;
|
|
143
|
+
templateText: string;
|
|
144
|
+
type: string;
|
|
145
|
+
}
|
|
146
|
+
/**
|
|
147
|
+
* Specify and consolidates authorization related information for the App.
|
|
148
|
+
*/
|
|
149
|
+
export interface TeamsManifestV1D19Authorization {
|
|
150
|
+
/**
|
|
151
|
+
* List of permissions that the app needs to function.
|
|
152
|
+
*/
|
|
153
|
+
permissions?: Permissions;
|
|
154
|
+
}
|
|
155
|
+
/**
|
|
156
|
+
* List of permissions that the app needs to function.
|
|
157
|
+
*/
|
|
158
|
+
export interface Permissions {
|
|
159
|
+
/**
|
|
160
|
+
* Permissions that must be granted on a per resource instance basis.
|
|
161
|
+
*/
|
|
162
|
+
resourceSpecific?: ResourceSpecific[];
|
|
163
|
+
}
|
|
164
|
+
export interface ResourceSpecific {
|
|
165
|
+
/**
|
|
166
|
+
* The name of the resource-specific permission.
|
|
167
|
+
*/
|
|
168
|
+
name: string;
|
|
169
|
+
/**
|
|
170
|
+
* The type of the resource-specific permission: delegated vs application.
|
|
171
|
+
*/
|
|
172
|
+
type: ResourceSpecificType;
|
|
173
|
+
}
|
|
174
|
+
/**
|
|
175
|
+
* The type of the resource-specific permission: delegated vs application.
|
|
176
|
+
*/
|
|
177
|
+
export type ResourceSpecificType = "Application" | "Delegated";
|
|
178
|
+
export interface Bot {
|
|
179
|
+
/**
|
|
180
|
+
* The Microsoft App ID specified for the bot in the Bot Framework portal
|
|
181
|
+
* (https://dev.botframework.com/bots)
|
|
182
|
+
*/
|
|
183
|
+
botId: string;
|
|
184
|
+
/**
|
|
185
|
+
* The list of commands that the bot supplies, including their usage, description, and the
|
|
186
|
+
* scope for which the commands are valid. A separate command list should be used for each
|
|
187
|
+
* scope.
|
|
188
|
+
*/
|
|
189
|
+
commandLists?: CommandList[];
|
|
190
|
+
configuration?: Configuration;
|
|
191
|
+
/**
|
|
192
|
+
* A value indicating whether or not the bot is a one-way notification only bot, as opposed
|
|
193
|
+
* to a conversational bot.
|
|
194
|
+
*/
|
|
195
|
+
isNotificationOnly?: boolean;
|
|
196
|
+
/**
|
|
197
|
+
* This value describes whether or not the bot utilizes a user hint to add the bot to a
|
|
198
|
+
* specific channel.
|
|
199
|
+
*/
|
|
200
|
+
needsChannelSelector?: boolean;
|
|
201
|
+
/**
|
|
202
|
+
* Specifies whether the bot offers an experience in the context of a channel in a team, in
|
|
203
|
+
* a 1:1 or group chat, or in an experience scoped to an individual user alone. These
|
|
204
|
+
* options are non-exclusive.
|
|
205
|
+
*/
|
|
206
|
+
scopes: CommandListScope[];
|
|
207
|
+
/**
|
|
208
|
+
* A value indicating whether the bot supports audio calling.
|
|
209
|
+
*/
|
|
210
|
+
supportsCalling?: boolean;
|
|
211
|
+
/**
|
|
212
|
+
* A value indicating whether the bot supports uploading/downloading of files.
|
|
213
|
+
*/
|
|
214
|
+
supportsFiles?: boolean;
|
|
215
|
+
/**
|
|
216
|
+
* A value indicating whether the bot supports video calling.
|
|
217
|
+
*/
|
|
218
|
+
supportsVideo?: boolean;
|
|
219
|
+
}
|
|
220
|
+
export interface CommandList {
|
|
221
|
+
commands: CommandListCommand[];
|
|
222
|
+
/**
|
|
223
|
+
* Specifies the scopes for which the command list is valid
|
|
224
|
+
*/
|
|
225
|
+
scopes: CommandListScope[];
|
|
226
|
+
}
|
|
227
|
+
export interface CommandListCommand {
|
|
228
|
+
/**
|
|
229
|
+
* A simple text description or an example of the command syntax and its arguments.
|
|
230
|
+
*/
|
|
231
|
+
description: string;
|
|
232
|
+
/**
|
|
233
|
+
* The bot command name
|
|
234
|
+
*/
|
|
235
|
+
title: string;
|
|
236
|
+
}
|
|
237
|
+
export type CommandListScope = "team" | "personal" | "groupChat";
|
|
238
|
+
export interface Configuration {
|
|
239
|
+
groupChat?: GroupChat;
|
|
240
|
+
team?: GroupChat;
|
|
241
|
+
}
|
|
242
|
+
export interface GroupChat {
|
|
243
|
+
fetchTask?: boolean;
|
|
244
|
+
taskInfo?: TaskInfo;
|
|
245
|
+
}
|
|
246
|
+
export interface TaskInfo {
|
|
247
|
+
/**
|
|
248
|
+
* Dialog height - either a number in pixels or default layout such as 'large', 'medium', or
|
|
249
|
+
* 'small'
|
|
250
|
+
*/
|
|
251
|
+
height?: string;
|
|
252
|
+
/**
|
|
253
|
+
* Initial dialog title
|
|
254
|
+
*/
|
|
255
|
+
title?: string;
|
|
256
|
+
/**
|
|
257
|
+
* Initial webview URL
|
|
258
|
+
*/
|
|
259
|
+
url?: string;
|
|
260
|
+
/**
|
|
261
|
+
* Dialog width - either a number in pixels or default layout such as 'large', 'medium', or
|
|
262
|
+
* 'small'
|
|
263
|
+
*/
|
|
264
|
+
width?: string;
|
|
265
|
+
}
|
|
266
|
+
export interface ComposeExtension {
|
|
267
|
+
/**
|
|
268
|
+
* A relative file path to the api specification file in the manifest package.
|
|
269
|
+
*/
|
|
270
|
+
apiSpecificationFile?: string;
|
|
271
|
+
/**
|
|
272
|
+
* Object capturing authorization information.
|
|
273
|
+
*/
|
|
274
|
+
authorization?: ComposeExtensionAuthorization;
|
|
275
|
+
/**
|
|
276
|
+
* The Microsoft App ID specified for the bot powering the compose extension in the Bot
|
|
277
|
+
* Framework portal (https://dev.botframework.com/bots)
|
|
278
|
+
*/
|
|
279
|
+
botId?: string;
|
|
280
|
+
/**
|
|
281
|
+
* A value indicating whether the configuration of a compose extension can be updated by the
|
|
282
|
+
* user.
|
|
283
|
+
*/
|
|
284
|
+
canUpdateConfiguration?: boolean | null;
|
|
285
|
+
commands?: ComposeExtensionCommand[];
|
|
286
|
+
/**
|
|
287
|
+
* Type of the compose extension.
|
|
288
|
+
*/
|
|
289
|
+
composeExtensionType?: ComposeExtensionType;
|
|
290
|
+
/**
|
|
291
|
+
* A list of handlers that allow apps to be invoked when certain conditions are met
|
|
292
|
+
*/
|
|
293
|
+
messageHandlers?: MessageHandler[];
|
|
294
|
+
}
|
|
295
|
+
/**
|
|
296
|
+
* Object capturing authorization information.
|
|
297
|
+
*/
|
|
298
|
+
export interface ComposeExtensionAuthorization {
|
|
299
|
+
/**
|
|
300
|
+
* Object capturing details needed to do service auth. It will be only present when auth
|
|
301
|
+
* type is apiSecretServiceAuth.
|
|
302
|
+
*/
|
|
303
|
+
apiSecretServiceAuthConfiguration?: APISecretServiceAuthConfiguration;
|
|
304
|
+
/**
|
|
305
|
+
* Enum of possible authentication types.
|
|
306
|
+
*/
|
|
307
|
+
authType?: AuthType;
|
|
308
|
+
/**
|
|
309
|
+
* Object capturing details needed to do single aad auth flow. It will be only present when
|
|
310
|
+
* auth type is entraId.
|
|
311
|
+
*/
|
|
312
|
+
microsoftEntraConfiguration?: MicrosoftEntraConfiguration;
|
|
313
|
+
}
|
|
314
|
+
/**
|
|
315
|
+
* Object capturing details needed to do service auth. It will be only present when auth
|
|
316
|
+
* type is apiSecretServiceAuth.
|
|
317
|
+
*/
|
|
318
|
+
export interface APISecretServiceAuthConfiguration {
|
|
319
|
+
/**
|
|
320
|
+
* Registration id returned when developer submits the api key through Developer Portal.
|
|
321
|
+
*/
|
|
322
|
+
apiSecretRegistrationId?: string;
|
|
323
|
+
}
|
|
324
|
+
/**
|
|
325
|
+
* Enum of possible authentication types.
|
|
326
|
+
*/
|
|
327
|
+
export type AuthType = "none" | "apiSecretServiceAuth" | "microsoftEntra";
|
|
328
|
+
/**
|
|
329
|
+
* Object capturing details needed to do single aad auth flow. It will be only present when
|
|
330
|
+
* auth type is entraId.
|
|
331
|
+
*/
|
|
332
|
+
export interface MicrosoftEntraConfiguration {
|
|
333
|
+
/**
|
|
334
|
+
* Boolean indicating whether single sign on is configured for the app.
|
|
335
|
+
*/
|
|
336
|
+
supportsSingleSignOn?: boolean;
|
|
337
|
+
}
|
|
338
|
+
export interface ComposeExtensionCommand {
|
|
339
|
+
/**
|
|
340
|
+
* A relative file path for api response rendering template file.
|
|
341
|
+
*/
|
|
342
|
+
apiResponseRenderingTemplateFile?: string;
|
|
343
|
+
/**
|
|
344
|
+
* Context where the command would apply
|
|
345
|
+
*/
|
|
346
|
+
context?: CommandContext[];
|
|
347
|
+
/**
|
|
348
|
+
* Description of the command.
|
|
349
|
+
*/
|
|
350
|
+
description?: string;
|
|
351
|
+
/**
|
|
352
|
+
* A boolean value that indicates if it should fetch task module dynamically
|
|
353
|
+
*/
|
|
354
|
+
fetchTask?: boolean;
|
|
355
|
+
/**
|
|
356
|
+
* Id of the command.
|
|
357
|
+
*/
|
|
358
|
+
id: string;
|
|
359
|
+
/**
|
|
360
|
+
* A boolean value that indicates if the command should be run once initially with no
|
|
361
|
+
* parameter.
|
|
362
|
+
*/
|
|
363
|
+
initialRun?: boolean;
|
|
364
|
+
parameters?: Parameter[];
|
|
365
|
+
samplePrompts?: SamplePrompt[];
|
|
366
|
+
/**
|
|
367
|
+
* Semantic description for the command.
|
|
368
|
+
*/
|
|
369
|
+
semanticDescription?: string;
|
|
370
|
+
taskInfo?: TaskInfo;
|
|
371
|
+
/**
|
|
372
|
+
* Title of the command.
|
|
373
|
+
*/
|
|
374
|
+
title: string;
|
|
375
|
+
/**
|
|
376
|
+
* Type of the command
|
|
377
|
+
*/
|
|
378
|
+
type?: CommandType;
|
|
379
|
+
}
|
|
380
|
+
export type CommandContext = "compose" | "commandBox" | "message";
|
|
381
|
+
export interface Parameter {
|
|
382
|
+
/**
|
|
383
|
+
* The choice options for the parameter
|
|
384
|
+
*/
|
|
385
|
+
choices?: Choice[];
|
|
386
|
+
/**
|
|
387
|
+
* Description of the parameter.
|
|
388
|
+
*/
|
|
389
|
+
description?: string;
|
|
390
|
+
/**
|
|
391
|
+
* Type of the parameter
|
|
392
|
+
*/
|
|
393
|
+
inputType?: InputType;
|
|
394
|
+
/**
|
|
395
|
+
* The value indicates if this parameter is a required field.
|
|
396
|
+
*/
|
|
397
|
+
isRequired?: boolean;
|
|
398
|
+
/**
|
|
399
|
+
* Name of the parameter.
|
|
400
|
+
*/
|
|
401
|
+
name: string;
|
|
402
|
+
/**
|
|
403
|
+
* Semantic description for the parameter.
|
|
404
|
+
*/
|
|
405
|
+
semanticDescription?: string;
|
|
406
|
+
/**
|
|
407
|
+
* Title of the parameter.
|
|
408
|
+
*/
|
|
409
|
+
title: string;
|
|
410
|
+
/**
|
|
411
|
+
* Initial value for the parameter
|
|
412
|
+
*/
|
|
413
|
+
value?: string;
|
|
414
|
+
}
|
|
415
|
+
export interface Choice {
|
|
416
|
+
/**
|
|
417
|
+
* Title of the choice
|
|
418
|
+
*/
|
|
419
|
+
title: string;
|
|
420
|
+
/**
|
|
421
|
+
* Value of the choice
|
|
422
|
+
*/
|
|
423
|
+
value: string;
|
|
424
|
+
}
|
|
425
|
+
/**
|
|
426
|
+
* Type of the parameter
|
|
427
|
+
*/
|
|
428
|
+
export type InputType = "text" | "textarea" | "number" | "date" | "time" | "toggle" | "choiceset";
|
|
429
|
+
export interface SamplePrompt {
|
|
430
|
+
/**
|
|
431
|
+
* This string will hold the sample prompt
|
|
432
|
+
*/
|
|
433
|
+
text: string;
|
|
434
|
+
}
|
|
435
|
+
/**
|
|
436
|
+
* Type of the command
|
|
437
|
+
*/
|
|
438
|
+
export type CommandType = "query" | "action";
|
|
439
|
+
/**
|
|
440
|
+
* Type of the compose extension.
|
|
441
|
+
*/
|
|
442
|
+
export type ComposeExtensionType = "botBased" | "apiBased";
|
|
443
|
+
export interface MessageHandler {
|
|
444
|
+
/**
|
|
445
|
+
* Type of the message handler
|
|
446
|
+
*/
|
|
447
|
+
type: "link";
|
|
448
|
+
value: Value;
|
|
449
|
+
}
|
|
450
|
+
/**
|
|
451
|
+
* Type of the message handler
|
|
452
|
+
*/
|
|
453
|
+
export interface Value {
|
|
454
|
+
/**
|
|
455
|
+
* A list of domains that the link message handler can register for, and when they are
|
|
456
|
+
* matched the app will be invoked
|
|
457
|
+
*/
|
|
458
|
+
domains?: string[];
|
|
459
|
+
/**
|
|
460
|
+
* A boolean that indicates whether the app's link message handler supports anonymous invoke
|
|
461
|
+
* flow.
|
|
462
|
+
*/
|
|
463
|
+
supportsAnonymizedPayloads?: boolean;
|
|
464
|
+
[property: string]: any;
|
|
465
|
+
}
|
|
466
|
+
export type ConfigurableProperty = "name" | "shortDescription" | "longDescription" | "smallImageUrl" | "largeImageUrl" | "accentColor" | "developerUrl" | "privacyUrl" | "termsOfUseUrl";
|
|
467
|
+
export interface ConfigurableTab {
|
|
468
|
+
/**
|
|
469
|
+
* A value indicating whether an instance of the tab's configuration can be updated by the
|
|
470
|
+
* user after creation.
|
|
471
|
+
*/
|
|
472
|
+
canUpdateConfiguration?: boolean;
|
|
473
|
+
/**
|
|
474
|
+
* The url to use when configuring the tab.
|
|
475
|
+
*/
|
|
476
|
+
configurationUrl: string;
|
|
477
|
+
/**
|
|
478
|
+
* The set of contextItem scopes that a tab belong to
|
|
479
|
+
*/
|
|
480
|
+
context?: ConfigurableTabContext[];
|
|
481
|
+
/**
|
|
482
|
+
* The set of meetingSurfaceItem scopes that a tab belong to
|
|
483
|
+
*/
|
|
484
|
+
meetingSurfaces?: MeetingSurface[];
|
|
485
|
+
/**
|
|
486
|
+
* Specifies whether the tab offers an experience in the context of a channel in a team, in
|
|
487
|
+
* a 1:1 or group chat, or in an experience scoped to an individual user alone. These
|
|
488
|
+
* options are non-exclusive. Currently, configurable tabs are only supported in the teams
|
|
489
|
+
* and groupchats scopes.
|
|
490
|
+
*/
|
|
491
|
+
scopes: ConfigurableTabScope[];
|
|
492
|
+
/**
|
|
493
|
+
* A relative file path to a tab preview image for use in SharePoint. Size 1024x768.
|
|
494
|
+
*/
|
|
495
|
+
sharePointPreviewImage?: string;
|
|
496
|
+
/**
|
|
497
|
+
* Defines how your tab will be made available in SharePoint.
|
|
498
|
+
*/
|
|
499
|
+
supportedSharePointHosts?: SupportedSharePointHost[];
|
|
500
|
+
}
|
|
501
|
+
export type ConfigurableTabContext = "personalTab" | "channelTab" | "privateChatTab" | "meetingChatTab" | "meetingDetailsTab" | "meetingSidePanel" | "meetingStage";
|
|
502
|
+
export type MeetingSurface = "sidePanel" | "stage";
|
|
503
|
+
export type ConfigurableTabScope = "team" | "groupChat";
|
|
504
|
+
export type SupportedSharePointHost = "sharePointFullPage" | "sharePointWebPart";
|
|
505
|
+
export interface Connector {
|
|
506
|
+
/**
|
|
507
|
+
* The url to use for configuring the connector using the inline configuration experience.
|
|
508
|
+
*/
|
|
509
|
+
configurationUrl?: string;
|
|
510
|
+
/**
|
|
511
|
+
* A unique identifier for the connector which matches its ID in the Connectors Developer
|
|
512
|
+
* Portal.
|
|
513
|
+
*/
|
|
514
|
+
connectorId: string;
|
|
515
|
+
/**
|
|
516
|
+
* Specifies whether the connector offers an experience in the context of a channel in a
|
|
517
|
+
* team, or an experience scoped to an individual user alone. Currently, only the team scope
|
|
518
|
+
* is supported.
|
|
519
|
+
*/
|
|
520
|
+
scopes: "team"[];
|
|
521
|
+
}
|
|
522
|
+
export interface CopilotAgents {
|
|
523
|
+
/**
|
|
524
|
+
* An array of declarative agent elements references. Currently, only one declarative agent
|
|
525
|
+
* per application is supported.
|
|
526
|
+
*/
|
|
527
|
+
declarativeAgents: DeclarativeAgentRef[];
|
|
528
|
+
}
|
|
529
|
+
/**
|
|
530
|
+
* A reference to a declarative agent element. The element's definition is in a separate
|
|
531
|
+
* file.
|
|
532
|
+
*/
|
|
533
|
+
export interface DeclarativeAgentRef {
|
|
534
|
+
/**
|
|
535
|
+
* Relative file path to this declarative agent element file in the application package.
|
|
536
|
+
*/
|
|
537
|
+
file: string;
|
|
538
|
+
/**
|
|
539
|
+
* A unique identifier for this declarative agent element.
|
|
540
|
+
*/
|
|
541
|
+
id: string;
|
|
542
|
+
}
|
|
543
|
+
/**
|
|
544
|
+
* Cards wich could be pinned to dashboard providing summarized view of information relevant
|
|
545
|
+
* to user.
|
|
546
|
+
*/
|
|
547
|
+
export interface DashboardCard {
|
|
548
|
+
contentSource: DashboardCardContentSource;
|
|
549
|
+
/**
|
|
550
|
+
* Rendering Size for dashboard card.
|
|
551
|
+
*/
|
|
552
|
+
defaultSize: DefaultSize;
|
|
553
|
+
/**
|
|
554
|
+
* Description of the card.Maximum length is 255 characters.
|
|
555
|
+
*/
|
|
556
|
+
description: string;
|
|
557
|
+
/**
|
|
558
|
+
* Represents the name of the card. Maximum length is 255 characters.
|
|
559
|
+
*/
|
|
560
|
+
displayName: string;
|
|
561
|
+
icon?: DashboardCardIcon;
|
|
562
|
+
/**
|
|
563
|
+
* Unique Id for the card. Must be unique inside the app.
|
|
564
|
+
*/
|
|
565
|
+
id: string;
|
|
566
|
+
/**
|
|
567
|
+
* Id of the group in the card picker. This must be guid.
|
|
568
|
+
*/
|
|
569
|
+
pickerGroupId: string;
|
|
570
|
+
}
|
|
571
|
+
/**
|
|
572
|
+
* Represents a configuration for the source of the card’s content.
|
|
573
|
+
*/
|
|
574
|
+
export interface DashboardCardContentSource {
|
|
575
|
+
/**
|
|
576
|
+
* The configuration for the bot source. Required if sourceType is set to bot.
|
|
577
|
+
*/
|
|
578
|
+
botConfiguration?: BotConfiguration;
|
|
579
|
+
/**
|
|
580
|
+
* The content of the dashboard card is sourced from a bot.
|
|
581
|
+
*/
|
|
582
|
+
sourceType?: "bot";
|
|
583
|
+
}
|
|
584
|
+
/**
|
|
585
|
+
* The configuration for the bot source. Required if sourceType is set to bot.
|
|
586
|
+
*/
|
|
587
|
+
export interface BotConfiguration {
|
|
588
|
+
/**
|
|
589
|
+
* The unique Microsoft app ID for the bot as registered with the Bot Framework.
|
|
590
|
+
*/
|
|
591
|
+
botId?: string;
|
|
592
|
+
}
|
|
593
|
+
/**
|
|
594
|
+
* The content of the dashboard card is sourced from a bot.
|
|
595
|
+
*/
|
|
596
|
+
/**
|
|
597
|
+
* Rendering Size for dashboard card.
|
|
598
|
+
*/
|
|
599
|
+
export type DefaultSize = "medium" | "large";
|
|
600
|
+
/**
|
|
601
|
+
* Represents a configuration for the source of the card’s content
|
|
602
|
+
*/
|
|
603
|
+
export interface DashboardCardIcon {
|
|
604
|
+
/**
|
|
605
|
+
* The icon for the card, to be displayed in the toolbox and card bar, represented as URL.
|
|
606
|
+
*/
|
|
607
|
+
iconUrl?: string;
|
|
608
|
+
/**
|
|
609
|
+
* Office UI Fabric/Fluent UI icon friendly name for the card. This value will be used if
|
|
610
|
+
* ‘iconUrl’ is not specified.
|
|
611
|
+
*/
|
|
612
|
+
officeUIFabricIconName?: string;
|
|
613
|
+
}
|
|
614
|
+
/**
|
|
615
|
+
* When a group install scope is selected, this will define the default capability when the
|
|
616
|
+
* user installs the app
|
|
617
|
+
*/
|
|
618
|
+
export interface DefaultGroupCapability {
|
|
619
|
+
/**
|
|
620
|
+
* When the install scope selected is GroupChat, this field specifies the default capability
|
|
621
|
+
* available
|
|
622
|
+
*/
|
|
623
|
+
groupchat?: Groupchat;
|
|
624
|
+
/**
|
|
625
|
+
* When the install scope selected is Meetings, this field specifies the default capability
|
|
626
|
+
* available
|
|
627
|
+
*/
|
|
628
|
+
meetings?: Groupchat;
|
|
629
|
+
/**
|
|
630
|
+
* When the install scope selected is Team, this field specifies the default capability
|
|
631
|
+
* available
|
|
632
|
+
*/
|
|
633
|
+
team?: Groupchat;
|
|
634
|
+
}
|
|
635
|
+
/**
|
|
636
|
+
* When the install scope selected is GroupChat, this field specifies the default capability
|
|
637
|
+
* available
|
|
638
|
+
*
|
|
639
|
+
* When the install scope selected is Meetings, this field specifies the default capability
|
|
640
|
+
* available
|
|
641
|
+
*
|
|
642
|
+
* When the install scope selected is Team, this field specifies the default capability
|
|
643
|
+
* available
|
|
644
|
+
*/
|
|
645
|
+
export type Groupchat = "tab" | "bot" | "connector";
|
|
646
|
+
/**
|
|
647
|
+
* The install scope defined for this app by default. This will be the option displayed on
|
|
648
|
+
* the button when a user tries to add the app
|
|
649
|
+
*/
|
|
650
|
+
export type DefaultInstallScope = "personal" | "team" | "groupChat" | "meetings";
|
|
651
|
+
export interface Description {
|
|
652
|
+
/**
|
|
653
|
+
* The full description of the app. Maximum length is 4000 characters.
|
|
654
|
+
*/
|
|
655
|
+
full: string;
|
|
656
|
+
/**
|
|
657
|
+
* A short description of the app used when space is limited. Maximum length is 80
|
|
658
|
+
* characters.
|
|
659
|
+
*/
|
|
660
|
+
short: string;
|
|
661
|
+
}
|
|
662
|
+
export interface Developer {
|
|
663
|
+
/**
|
|
664
|
+
* The Microsoft Partner Network ID that identifies the partner organization building the
|
|
665
|
+
* app. This field is not required, and should only be used if you are already part of the
|
|
666
|
+
* Microsoft Partner Network. More info at https://aka.ms/partner
|
|
667
|
+
*/
|
|
668
|
+
mpnId?: string;
|
|
669
|
+
/**
|
|
670
|
+
* The display name for the developer.
|
|
671
|
+
*/
|
|
672
|
+
name: string;
|
|
673
|
+
/**
|
|
674
|
+
* The url to the page that provides privacy information for the app.
|
|
675
|
+
*/
|
|
676
|
+
privacyUrl: string;
|
|
677
|
+
/**
|
|
678
|
+
* The url to the page that provides the terms of use for the app.
|
|
679
|
+
*/
|
|
680
|
+
termsOfUseUrl: string;
|
|
681
|
+
/**
|
|
682
|
+
* The url to the page that provides support information for the app.
|
|
683
|
+
*/
|
|
684
|
+
websiteUrl: string;
|
|
685
|
+
}
|
|
686
|
+
export type DevicePermission = "geolocation" | "media" | "notifications" | "midi" | "openExternal";
|
|
687
|
+
/**
|
|
688
|
+
* The set of extensions for this app. Currently only one extensions per app is supported.
|
|
689
|
+
*/
|
|
690
|
+
export interface ElementExtension {
|
|
691
|
+
alternates?: ExtensionAlternateVersionsArray[];
|
|
692
|
+
/**
|
|
693
|
+
* The url for your extension, used to validate Exchange user identity tokens.
|
|
694
|
+
*/
|
|
695
|
+
audienceClaimUrl?: string;
|
|
696
|
+
autoRunEvents?: ExtensionAutoRunEventsArray[];
|
|
697
|
+
requirements?: RequirementsExtensionElement;
|
|
698
|
+
ribbons?: ExtensionRibbonsArray[];
|
|
699
|
+
runtimes?: ExtensionRuntimesArray[];
|
|
700
|
+
}
|
|
701
|
+
export interface ExtensionAlternateVersionsArray {
|
|
702
|
+
alternateIcons?: AlternateIcons;
|
|
703
|
+
hide?: Hide;
|
|
704
|
+
prefer?: Prefer;
|
|
705
|
+
requirements?: RequirementsExtensionElement;
|
|
706
|
+
}
|
|
707
|
+
export interface AlternateIcons {
|
|
708
|
+
highResolutionIcon: ExtensionCommonIcon;
|
|
709
|
+
icon: ExtensionCommonIcon;
|
|
710
|
+
}
|
|
711
|
+
export interface ExtensionCommonIcon {
|
|
712
|
+
/**
|
|
713
|
+
* Size in pixels of the icon. Three image sizes are required (16, 32, and 80 pixels)
|
|
714
|
+
*/
|
|
715
|
+
size: number;
|
|
716
|
+
/**
|
|
717
|
+
* Absolute Url to the icon.
|
|
718
|
+
*/
|
|
719
|
+
url: string;
|
|
720
|
+
}
|
|
721
|
+
export interface Hide {
|
|
722
|
+
customOfficeAddin?: CustomOfficeAddin;
|
|
723
|
+
storeOfficeAddin?: StoreOfficeAddin;
|
|
724
|
+
[property: string]: any;
|
|
725
|
+
}
|
|
726
|
+
export interface CustomOfficeAddin {
|
|
727
|
+
/**
|
|
728
|
+
* Solution ID of the in-market add-in to hide. Maximum length is 64 characters.
|
|
729
|
+
*/
|
|
730
|
+
officeAddinId: string;
|
|
731
|
+
}
|
|
732
|
+
export interface StoreOfficeAddin {
|
|
733
|
+
/**
|
|
734
|
+
* Asset ID of the in-market add-in to hide. Maximum length is 64 characters.
|
|
735
|
+
*/
|
|
736
|
+
assetId: string;
|
|
737
|
+
/**
|
|
738
|
+
* Solution ID of an in-market add-in to hide. Maximum length is 64 characters.
|
|
739
|
+
*/
|
|
740
|
+
officeAddinId: string;
|
|
741
|
+
}
|
|
742
|
+
export interface Prefer {
|
|
743
|
+
comAddin?: COMAddin;
|
|
744
|
+
[property: string]: any;
|
|
745
|
+
}
|
|
746
|
+
export interface COMAddin {
|
|
747
|
+
/**
|
|
748
|
+
* Program ID of the alternate com extension. Maximum length is 64 characters.
|
|
749
|
+
*/
|
|
750
|
+
progId: string;
|
|
751
|
+
}
|
|
752
|
+
export interface RequirementsExtensionElement {
|
|
753
|
+
capabilities?: Capability[];
|
|
754
|
+
/**
|
|
755
|
+
* Identifies the form factors that support the add-in. Supported values: mobile, desktop.
|
|
756
|
+
*/
|
|
757
|
+
formFactors?: FormFactor[];
|
|
758
|
+
/**
|
|
759
|
+
* Identifies the scopes in which the add-in can run.
|
|
760
|
+
*/
|
|
761
|
+
scopes?: RequirementsScope[];
|
|
762
|
+
}
|
|
763
|
+
export interface Capability {
|
|
764
|
+
/**
|
|
765
|
+
* Identifies the maximum version for the requirement sets that the add-in needs to run.
|
|
766
|
+
*/
|
|
767
|
+
maxVersion?: string;
|
|
768
|
+
/**
|
|
769
|
+
* Identifies the minimum version for the requirement sets that the add-in needs to run.
|
|
770
|
+
*/
|
|
771
|
+
minVersion?: string;
|
|
772
|
+
/**
|
|
773
|
+
* Identifies the name of the requirement sets that the add-in needs to run.
|
|
774
|
+
*/
|
|
775
|
+
name: string;
|
|
776
|
+
}
|
|
777
|
+
export type FormFactor = "desktop" | "mobile";
|
|
778
|
+
export type RequirementsScope = "mail" | "workbook" | "document" | "presentation";
|
|
779
|
+
export interface ExtensionAutoRunEventsArray {
|
|
780
|
+
/**
|
|
781
|
+
* Specifies the type of event. For supported types, please see:
|
|
782
|
+
* https://review.learn.microsoft.com/en-us/office/dev/add-ins/outlook/autolaunch?tabs=xmlmanifest#supported-events.
|
|
783
|
+
*/
|
|
784
|
+
events: Event[];
|
|
785
|
+
requirements?: RequirementsExtensionElement;
|
|
786
|
+
}
|
|
787
|
+
export interface Event {
|
|
788
|
+
/**
|
|
789
|
+
* The ID of an action defined in runtimes. Maximum length is 64 characters.
|
|
790
|
+
*/
|
|
791
|
+
actionId: string;
|
|
792
|
+
/**
|
|
793
|
+
* Configures how Outlook responds to the event.
|
|
794
|
+
*/
|
|
795
|
+
options?: Options;
|
|
796
|
+
type: string;
|
|
797
|
+
}
|
|
798
|
+
/**
|
|
799
|
+
* Configures how Outlook responds to the event.
|
|
800
|
+
*/
|
|
801
|
+
export interface Options {
|
|
802
|
+
sendMode: SendMode;
|
|
803
|
+
}
|
|
804
|
+
export type SendMode = "promptUser" | "softBlock" | "block";
|
|
805
|
+
export interface ExtensionRibbonsArray {
|
|
806
|
+
contexts?: ExtensionContext[];
|
|
807
|
+
requirements?: RequirementsExtensionElement;
|
|
808
|
+
tabs: ExtensionRibbonsArrayTabsItem[];
|
|
809
|
+
}
|
|
810
|
+
/**
|
|
811
|
+
* Specifies the Office application windows in which the ribbon customization is available
|
|
812
|
+
* to the user. Each item in the array is a member of a string array. Possible values are:
|
|
813
|
+
* mailRead, mailCompose, meetingDetailsOrganizer, meetingDetailsAttendee.
|
|
814
|
+
*/
|
|
815
|
+
export type ExtensionContext = "mailRead" | "mailCompose" | "meetingDetailsOrganizer" | "meetingDetailsAttendee" | "onlineMeetingDetailsOrganizer" | "logEventMeetingDetailsAttendee" | "default";
|
|
816
|
+
export interface ExtensionRibbonsArrayTabsItem {
|
|
817
|
+
/**
|
|
818
|
+
* Id of the existing office Tab. Maximum length is 64 characters.
|
|
819
|
+
*/
|
|
820
|
+
builtInTabId?: string;
|
|
821
|
+
/**
|
|
822
|
+
* Defines mobile group item.
|
|
823
|
+
*/
|
|
824
|
+
customMobileRibbonGroups?: ExtensionRibbonsCustomMobileGroupItem[];
|
|
825
|
+
/**
|
|
826
|
+
* Defines tab groups.
|
|
827
|
+
*/
|
|
828
|
+
groups?: ExtensionRibbonsCustomTabGroupsItem[];
|
|
829
|
+
/**
|
|
830
|
+
* A unique identifier for this tab within the app. Maximum length is 64 characters.
|
|
831
|
+
*/
|
|
832
|
+
id?: string;
|
|
833
|
+
/**
|
|
834
|
+
* Displayed text for the tab. Maximum length is 64 characters.
|
|
835
|
+
*/
|
|
836
|
+
label?: string;
|
|
837
|
+
position?: Position;
|
|
838
|
+
}
|
|
839
|
+
export interface ExtensionRibbonsCustomMobileGroupItem {
|
|
840
|
+
controls: ExtensionRibbonsCustomMobileControlButtonItem[];
|
|
841
|
+
/**
|
|
842
|
+
* Specify the Id of the group. Used for mobileMessageRead ext point.
|
|
843
|
+
*/
|
|
844
|
+
id: string;
|
|
845
|
+
/**
|
|
846
|
+
* Short label of the control. Maximum length is 32 characters.
|
|
847
|
+
*/
|
|
848
|
+
label: string;
|
|
849
|
+
[property: string]: any;
|
|
850
|
+
}
|
|
851
|
+
export interface ExtensionRibbonsCustomMobileControlButtonItem {
|
|
852
|
+
/**
|
|
853
|
+
* The ID of an action defined in runtimes. Maximum length is 64 characters.
|
|
854
|
+
*/
|
|
855
|
+
actionId: string;
|
|
856
|
+
icons: ExtensionCustomMobileIcon[];
|
|
857
|
+
/**
|
|
858
|
+
* Specify the Id of the button like msgReadFunctionButton.
|
|
859
|
+
*/
|
|
860
|
+
id: string;
|
|
861
|
+
/**
|
|
862
|
+
* Short label of the control. Maximum length is 32 characters.
|
|
863
|
+
*/
|
|
864
|
+
label: string;
|
|
865
|
+
type: "mobileButton";
|
|
866
|
+
[property: string]: any;
|
|
867
|
+
}
|
|
868
|
+
export interface ExtensionCustomMobileIcon {
|
|
869
|
+
/**
|
|
870
|
+
* How to scale - 1,2,3 for each image. This attribute specifies the UIScreen.scale property
|
|
871
|
+
* for iOS devices.
|
|
872
|
+
*/
|
|
873
|
+
scale: number;
|
|
874
|
+
/**
|
|
875
|
+
* Size in pixels of the icon. Three image sizes are required (25, 32, and 48 pixels).
|
|
876
|
+
*/
|
|
877
|
+
size: number;
|
|
878
|
+
/**
|
|
879
|
+
* Url to the icon.
|
|
880
|
+
*/
|
|
881
|
+
url: string;
|
|
882
|
+
}
|
|
883
|
+
export interface ExtensionRibbonsCustomTabGroupsItem {
|
|
884
|
+
/**
|
|
885
|
+
* Id of a built-in Group. Maximum length is 64 characters.
|
|
886
|
+
*/
|
|
887
|
+
builtInGroupId?: string;
|
|
888
|
+
controls?: ExtensionCommonCustomGroupControlsItem[];
|
|
889
|
+
icons?: ExtensionCommonIcon[];
|
|
890
|
+
/**
|
|
891
|
+
* A unique identifier for this group within the app. Maximum length is 64 characters.
|
|
892
|
+
*/
|
|
893
|
+
id?: string;
|
|
894
|
+
/**
|
|
895
|
+
* Displayed text for the group. Maximum length is 64 characters.
|
|
896
|
+
*/
|
|
897
|
+
label?: string;
|
|
898
|
+
}
|
|
899
|
+
export interface ExtensionCommonCustomGroupControlsItem {
|
|
900
|
+
/**
|
|
901
|
+
* The ID of an execution-type action that handles this key combination. Maximum length is
|
|
902
|
+
* 64 characters.
|
|
903
|
+
*/
|
|
904
|
+
actionId: string;
|
|
905
|
+
/**
|
|
906
|
+
* Id of the existing office control. Maximum length is 64 characters.
|
|
907
|
+
*/
|
|
908
|
+
builtInControlId?: string;
|
|
909
|
+
/**
|
|
910
|
+
* Whether the control is initially enabled.
|
|
911
|
+
*/
|
|
912
|
+
enabled?: boolean;
|
|
913
|
+
icons: ExtensionCommonIcon[];
|
|
914
|
+
/**
|
|
915
|
+
* A unique identifier for this control within the app. Maximum length is 64 characters.
|
|
916
|
+
*/
|
|
917
|
+
id: string;
|
|
918
|
+
/**
|
|
919
|
+
* Configures the items for a menu control.
|
|
920
|
+
*/
|
|
921
|
+
items?: ExtensionCommonCustomControlMenuItem[];
|
|
922
|
+
/**
|
|
923
|
+
* Displayed text for the control. Maximum length is 64 characters.
|
|
924
|
+
*/
|
|
925
|
+
label: string;
|
|
926
|
+
/**
|
|
927
|
+
* Specifies whether a group, button, menu, or menu item will be hidden on application and
|
|
928
|
+
* platform combinations that support the API (Office.ribbon.requestCreateControls) that
|
|
929
|
+
* installs custom contextual tabs on the ribbon. Default is false.
|
|
930
|
+
*/
|
|
931
|
+
overriddenByRibbonApi?: boolean;
|
|
932
|
+
supertip: ExtensionCommonSuperToolTip;
|
|
933
|
+
/**
|
|
934
|
+
* Defines the type of control whether button or menu.
|
|
935
|
+
*/
|
|
936
|
+
type: FluffyType;
|
|
937
|
+
}
|
|
938
|
+
export interface ExtensionCommonCustomControlMenuItem {
|
|
939
|
+
/**
|
|
940
|
+
* The ID of an action defined in runtimes. Maximum length is 64 characters.
|
|
941
|
+
*/
|
|
942
|
+
actionId: string;
|
|
943
|
+
/**
|
|
944
|
+
* Whether the control is initially enabled.
|
|
945
|
+
*/
|
|
946
|
+
enabled?: boolean;
|
|
947
|
+
icons?: ExtensionCommonIcon[];
|
|
948
|
+
/**
|
|
949
|
+
* A unique identifier for this control within the app. Maximum length is 64 characters.
|
|
950
|
+
*/
|
|
951
|
+
id: string;
|
|
952
|
+
/**
|
|
953
|
+
* Displayed text for the control. Maximum length is 64 characters.
|
|
954
|
+
*/
|
|
955
|
+
label: string;
|
|
956
|
+
overriddenByRibbonApi?: boolean;
|
|
957
|
+
supertip: ExtensionCommonSuperToolTip;
|
|
958
|
+
/**
|
|
959
|
+
* Supported values: menuItem.
|
|
960
|
+
*/
|
|
961
|
+
type: "menuItem";
|
|
962
|
+
}
|
|
963
|
+
export interface ExtensionCommonSuperToolTip {
|
|
964
|
+
/**
|
|
965
|
+
* Description of the super tip. Maximum length is 250 characters.
|
|
966
|
+
*/
|
|
967
|
+
description: string;
|
|
968
|
+
/**
|
|
969
|
+
* Title text of the super tip. Maximum length is 64 characters.
|
|
970
|
+
*/
|
|
971
|
+
title: string;
|
|
972
|
+
}
|
|
973
|
+
/**
|
|
974
|
+
* Supported values: menuItem.
|
|
975
|
+
*/
|
|
976
|
+
/**
|
|
977
|
+
* Defines the type of control whether button or menu.
|
|
978
|
+
*/
|
|
979
|
+
export type FluffyType = "button" | "menu";
|
|
980
|
+
export interface Position {
|
|
981
|
+
/**
|
|
982
|
+
* Define alignment of this custom tab relative to the specified built-in tab.
|
|
983
|
+
*/
|
|
984
|
+
align: Align;
|
|
985
|
+
/**
|
|
986
|
+
* The id of the built-in tab. Maximum length is 64 characters.
|
|
987
|
+
*/
|
|
988
|
+
builtInTabId: string;
|
|
989
|
+
}
|
|
990
|
+
/**
|
|
991
|
+
* Define alignment of this custom tab relative to the specified built-in tab.
|
|
992
|
+
*/
|
|
993
|
+
export type Align = "after" | "before";
|
|
994
|
+
/**
|
|
995
|
+
* A runtime environment for a page or script
|
|
996
|
+
*/
|
|
997
|
+
export interface ExtensionRuntimesArray {
|
|
998
|
+
actions?: ExtensionRuntimesActionsItem[];
|
|
999
|
+
code: ExtensionRuntimeCode;
|
|
1000
|
+
/**
|
|
1001
|
+
* A unique identifier for this runtime within the app. Maximum length is 64 characters.
|
|
1002
|
+
*/
|
|
1003
|
+
id: string;
|
|
1004
|
+
/**
|
|
1005
|
+
* Runtimes with a short lifetime do not preserve state across executions. Runtimes with a
|
|
1006
|
+
* long lifetime do.
|
|
1007
|
+
*/
|
|
1008
|
+
lifetime?: Lifetime;
|
|
1009
|
+
requirements?: RequirementsExtensionElement;
|
|
1010
|
+
/**
|
|
1011
|
+
* Supports running functions and launching pages.
|
|
1012
|
+
*/
|
|
1013
|
+
type?: "general";
|
|
1014
|
+
}
|
|
1015
|
+
/**
|
|
1016
|
+
* Specifies the set of actions supported by this runtime. An action is either running a
|
|
1017
|
+
* JavaScript function or opening a view such as a task pane.
|
|
1018
|
+
*/
|
|
1019
|
+
export interface ExtensionRuntimesActionsItem {
|
|
1020
|
+
/**
|
|
1021
|
+
* Display name of the action. Maximum length is 64 characters.
|
|
1022
|
+
*/
|
|
1023
|
+
displayName?: string;
|
|
1024
|
+
/**
|
|
1025
|
+
* Identifier for this action. Maximum length is 64 characters. This value is passed to the
|
|
1026
|
+
* code file.
|
|
1027
|
+
*/
|
|
1028
|
+
id: string;
|
|
1029
|
+
/**
|
|
1030
|
+
* Whether allows the action to have multiple selection.
|
|
1031
|
+
*/
|
|
1032
|
+
multiselect?: boolean;
|
|
1033
|
+
/**
|
|
1034
|
+
* Specifies that a task pane supports pinning, which keeps the task pane open when the user
|
|
1035
|
+
* changes the selection.
|
|
1036
|
+
*/
|
|
1037
|
+
pinnable?: boolean;
|
|
1038
|
+
/**
|
|
1039
|
+
* Whether allows task pane add-ins to activate without the Reading Pane enabled or a
|
|
1040
|
+
* message selected.
|
|
1041
|
+
*/
|
|
1042
|
+
supportsNoItemContext?: boolean;
|
|
1043
|
+
/**
|
|
1044
|
+
* executeFunction: Run a script function without waiting for it to finish. openPate: Open a
|
|
1045
|
+
* page in a view.
|
|
1046
|
+
*/
|
|
1047
|
+
type: ActionType;
|
|
1048
|
+
/**
|
|
1049
|
+
* View where the page should be opened. Maximum length is 64 characters.
|
|
1050
|
+
*/
|
|
1051
|
+
view?: string;
|
|
1052
|
+
}
|
|
1053
|
+
/**
|
|
1054
|
+
* executeFunction: Run a script function without waiting for it to finish. openPate: Open a
|
|
1055
|
+
* page in a view.
|
|
1056
|
+
*/
|
|
1057
|
+
export type ActionType = "executeFunction" | "openPage";
|
|
1058
|
+
export interface ExtensionRuntimeCode {
|
|
1059
|
+
/**
|
|
1060
|
+
* URL of the .html page to be loaded in browser-based runtimes.
|
|
1061
|
+
*/
|
|
1062
|
+
page: string;
|
|
1063
|
+
/**
|
|
1064
|
+
* URL of the .js script file to be loaded in UI-less runtimes.
|
|
1065
|
+
*/
|
|
1066
|
+
script?: string;
|
|
1067
|
+
}
|
|
1068
|
+
/**
|
|
1069
|
+
* Runtimes with a short lifetime do not preserve state across executions. Runtimes with a
|
|
1070
|
+
* long lifetime do.
|
|
1071
|
+
*/
|
|
1072
|
+
export type Lifetime = "short" | "long";
|
|
1073
|
+
/**
|
|
1074
|
+
* Supports running functions and launching pages.
|
|
1075
|
+
*/
|
|
1076
|
+
/**
|
|
1077
|
+
* Specify the app's Graph connector configuration. If this is present then
|
|
1078
|
+
* webApplicationInfo.id must also be specified.
|
|
1079
|
+
*/
|
|
1080
|
+
export interface GraphConnector {
|
|
1081
|
+
/**
|
|
1082
|
+
* The url where Graph-connector notifications for the application should be sent.
|
|
1083
|
+
*/
|
|
1084
|
+
notificationUrl: string;
|
|
1085
|
+
}
|
|
1086
|
+
export interface Icons {
|
|
1087
|
+
/**
|
|
1088
|
+
* A relative file path to a full color PNG icon. Size 192x192.
|
|
1089
|
+
*/
|
|
1090
|
+
color: string;
|
|
1091
|
+
/**
|
|
1092
|
+
* A relative file path to a transparent PNG outline icon. The border color needs to be
|
|
1093
|
+
* white. Size 32x32.
|
|
1094
|
+
*/
|
|
1095
|
+
outline: string;
|
|
1096
|
+
}
|
|
1097
|
+
export interface LocalizationInfo {
|
|
1098
|
+
additionalLanguages?: AdditionalLanguage[];
|
|
1099
|
+
/**
|
|
1100
|
+
* A relative file path to a the .json file containing strings in the default language.
|
|
1101
|
+
*/
|
|
1102
|
+
defaultLanguageFile?: string;
|
|
1103
|
+
/**
|
|
1104
|
+
* The language tag of the strings in this top level manifest file.
|
|
1105
|
+
*/
|
|
1106
|
+
defaultLanguageTag: string;
|
|
1107
|
+
}
|
|
1108
|
+
export interface AdditionalLanguage {
|
|
1109
|
+
/**
|
|
1110
|
+
* A relative file path to a the .json file containing the translated strings.
|
|
1111
|
+
*/
|
|
1112
|
+
file: string;
|
|
1113
|
+
/**
|
|
1114
|
+
* The language tag of the strings in the provided file.
|
|
1115
|
+
*/
|
|
1116
|
+
languageTag: string;
|
|
1117
|
+
}
|
|
1118
|
+
/**
|
|
1119
|
+
* Specify meeting extension definition.
|
|
1120
|
+
*/
|
|
1121
|
+
export interface MeetingExtensionDefinition {
|
|
1122
|
+
/**
|
|
1123
|
+
* Meeting supported scenes.
|
|
1124
|
+
*/
|
|
1125
|
+
scenes?: Scene[];
|
|
1126
|
+
/**
|
|
1127
|
+
* A boolean value indicating whether this app allows management by anonymous users.
|
|
1128
|
+
*/
|
|
1129
|
+
supportsAnonymousGuestUsers?: boolean;
|
|
1130
|
+
/**
|
|
1131
|
+
* A boolean value indicating whether this app can stream the meeting's audio video content
|
|
1132
|
+
* to an RTMP endpoint.
|
|
1133
|
+
*/
|
|
1134
|
+
supportsStreaming?: boolean;
|
|
1135
|
+
}
|
|
1136
|
+
export interface Scene {
|
|
1137
|
+
/**
|
|
1138
|
+
* A relative file path to a scene metadata json file.
|
|
1139
|
+
*/
|
|
1140
|
+
file: string;
|
|
1141
|
+
/**
|
|
1142
|
+
* A unique identifier for this scene. This id must be a GUID.
|
|
1143
|
+
*/
|
|
1144
|
+
id: string;
|
|
1145
|
+
/**
|
|
1146
|
+
* Maximum audiences supported in scene.
|
|
1147
|
+
*/
|
|
1148
|
+
maxAudience: number;
|
|
1149
|
+
/**
|
|
1150
|
+
* Scene name.
|
|
1151
|
+
*/
|
|
1152
|
+
name: string;
|
|
1153
|
+
/**
|
|
1154
|
+
* A relative file path to a scene PNG preview icon.
|
|
1155
|
+
*/
|
|
1156
|
+
preview: string;
|
|
1157
|
+
/**
|
|
1158
|
+
* Number of seats reserved for organizers or presenters.
|
|
1159
|
+
*/
|
|
1160
|
+
seatsReservedForOrganizersOrPresenters: number;
|
|
1161
|
+
}
|
|
1162
|
+
export interface Name {
|
|
1163
|
+
/**
|
|
1164
|
+
* The full name of the app, used if the full app name exceeds 30 characters.
|
|
1165
|
+
*/
|
|
1166
|
+
full: string;
|
|
1167
|
+
/**
|
|
1168
|
+
* A short display name for the app.
|
|
1169
|
+
*/
|
|
1170
|
+
short: string;
|
|
1171
|
+
}
|
|
1172
|
+
export type Permission = "identity" | "messageTeamMembers";
|
|
1173
|
+
export interface StaticTab {
|
|
1174
|
+
/**
|
|
1175
|
+
* The Microsoft App ID specified for the bot in the Bot Framework portal
|
|
1176
|
+
* (https://dev.botframework.com/bots)
|
|
1177
|
+
*/
|
|
1178
|
+
contentBotId?: string;
|
|
1179
|
+
/**
|
|
1180
|
+
* The url which points to the entity UI to be displayed in the canvas.
|
|
1181
|
+
*/
|
|
1182
|
+
contentUrl?: string;
|
|
1183
|
+
/**
|
|
1184
|
+
* The set of contextItem scopes that a tab belong to
|
|
1185
|
+
*/
|
|
1186
|
+
context?: StaticTabContext[];
|
|
1187
|
+
/**
|
|
1188
|
+
* A unique identifier for the entity which the tab displays.
|
|
1189
|
+
*/
|
|
1190
|
+
entityId: string;
|
|
1191
|
+
/**
|
|
1192
|
+
* The display name of the tab.
|
|
1193
|
+
*/
|
|
1194
|
+
name?: string;
|
|
1195
|
+
/**
|
|
1196
|
+
* Specifies whether the tab offers an experience in the context of a channel in a team, or
|
|
1197
|
+
* an experience scoped to an individual user alone or group chat. These options are
|
|
1198
|
+
* non-exclusive. Currently static tabs are only supported in the 'personal' scope.
|
|
1199
|
+
*/
|
|
1200
|
+
scopes: CommandListScope[];
|
|
1201
|
+
/**
|
|
1202
|
+
* The url to direct a user's search queries.
|
|
1203
|
+
*/
|
|
1204
|
+
searchUrl?: string;
|
|
1205
|
+
/**
|
|
1206
|
+
* The url to point at if a user opts to view in a browser.
|
|
1207
|
+
*/
|
|
1208
|
+
websiteUrl?: string;
|
|
1209
|
+
}
|
|
1210
|
+
export type StaticTabContext = "personalTab" | "channelTab" | "privateChatTab" | "meetingChatTab" | "meetingDetailsTab" | "meetingSidePanel" | "meetingStage" | "teamLevelApp";
|
|
1211
|
+
/**
|
|
1212
|
+
* Subscription offer associated with this app.
|
|
1213
|
+
*/
|
|
1214
|
+
export interface SubscriptionOffer {
|
|
1215
|
+
/**
|
|
1216
|
+
* A unique identifier for the Commercial Marketplace Software as a Service Offer.
|
|
1217
|
+
*/
|
|
1218
|
+
offerId: string;
|
|
1219
|
+
}
|
|
1220
|
+
export type SupportedChannelType = "sharedChannels" | "privateChannels";
|
|
1221
|
+
/**
|
|
1222
|
+
* Specify your AAD App ID and Graph information to help users seamlessly sign into your AAD
|
|
1223
|
+
* app.
|
|
1224
|
+
*/
|
|
1225
|
+
export interface WebApplicationInfo {
|
|
1226
|
+
/**
|
|
1227
|
+
* AAD application id of the app. This id must be a GUID.
|
|
1228
|
+
*/
|
|
1229
|
+
id: string;
|
|
1230
|
+
/**
|
|
1231
|
+
* Resource url of app for acquiring auth token for SSO.
|
|
1232
|
+
*/
|
|
1233
|
+
resource?: string;
|
|
1234
|
+
}
|
|
1235
|
+
export declare class Convert {
|
|
1236
|
+
static toTeamsManifestV1D19(json: string): TeamsManifestV1D19;
|
|
1237
|
+
static teamsManifestV1D19ToJson(value: TeamsManifestV1D19): string;
|
|
1238
|
+
}
|