@microsoft/app-manifest 1.0.4-alpha.2d07c92d5.0 → 1.0.4-alpha.3344620f2.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/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D6.d.ts +69 -6
- package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D6.js +19 -1
- package/build/generated-types/copilot/declarative-agent/DeclarativeAgentManifestV1D6.js.map +1 -1
- package/build/generated-types/copilot/plugin/ApiPluginManifestV2D2.d.ts +5 -5
- package/build/generated-types/copilot/plugin/ApiPluginManifestV2D2.js +2 -2
- package/build/generated-types/copilot/plugin/ApiPluginManifestV2D2.js.map +1 -1
- package/build/generated-types/copilot/plugin/ApiPluginManifestV2D3.d.ts +1 -5
- package/build/generated-types/copilot/plugin/ApiPluginManifestV2D3.js +1 -1
- package/build/generated-types/copilot/plugin/ApiPluginManifestV2D3.js.map +1 -1
- package/build/generated-types/copilot/plugin/ApiPluginManifestV2D4.d.ts +527 -0
- package/build/generated-types/copilot/plugin/ApiPluginManifestV2D4.js +320 -0
- package/build/generated-types/copilot/plugin/ApiPluginManifestV2D4.js.map +1 -0
- package/build/generated-types/index.d.ts +7 -4
- package/build/generated-types/index.js +23 -2
- package/build/generated-types/index.js.map +1 -1
- package/build/generated-types/teams/TeamsManifestV1D17.d.ts +1 -1
- package/build/generated-types/teams/TeamsManifestV1D19.d.ts +1 -1
- package/build/generated-types/teams/TeamsManifestV1D20.d.ts +1 -1
- package/build/generated-types/teams/TeamsManifestV1D21.d.ts +1 -1
- package/build/generated-types/teams/TeamsManifestV1D22.d.ts +1 -1
- package/build/generated-types/teams/TeamsManifestV1D23.d.ts +1941 -0
- package/build/generated-types/teams/TeamsManifestV1D23.js +983 -0
- package/build/generated-types/teams/TeamsManifestV1D23.js.map +1 -0
- package/build/generated-types/teams/TeamsManifestV1D24.d.ts +2027 -0
- package/build/generated-types/teams/TeamsManifestV1D24.js +1010 -0
- package/build/generated-types/teams/TeamsManifestV1D24.js.map +1 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/package.json +2 -2
|
@@ -0,0 +1,1941 @@
|
|
|
1
|
+
export interface TeamsManifestV1D23 {
|
|
2
|
+
$schema?: string;
|
|
3
|
+
/**
|
|
4
|
+
* The version of the schema this manifest is using. This schema version supports extending
|
|
5
|
+
* Teams apps to other parts of the Microsoft 365 ecosystem. More info at
|
|
6
|
+
* https://aka.ms/extendteamsapps.
|
|
7
|
+
*/
|
|
8
|
+
manifestVersion: "1.23";
|
|
9
|
+
/**
|
|
10
|
+
* The version of the app. Changes to your manifest should cause a version change. This
|
|
11
|
+
* version string must follow the semver standard (http://semver.org).
|
|
12
|
+
*/
|
|
13
|
+
version: string;
|
|
14
|
+
/**
|
|
15
|
+
* A unique identifier for this app. This id must be a GUID.
|
|
16
|
+
*/
|
|
17
|
+
id: string;
|
|
18
|
+
localizationInfo?: LocalizationInfo;
|
|
19
|
+
developer: Developer;
|
|
20
|
+
name: NameClass;
|
|
21
|
+
description: Description;
|
|
22
|
+
icons: Icons;
|
|
23
|
+
/**
|
|
24
|
+
* A color to use in conjunction with the icon. The value must be a valid HTML color code
|
|
25
|
+
* starting with '#', for example `#4464ee`.
|
|
26
|
+
*/
|
|
27
|
+
accentColor: string;
|
|
28
|
+
/**
|
|
29
|
+
* These are tabs users can optionally add to their channels and 1:1 or group chats and
|
|
30
|
+
* require extra configuration before they are added. Configurable tabs are not supported in
|
|
31
|
+
* the personal scope. Currently only one configurable tab per app is supported.
|
|
32
|
+
*/
|
|
33
|
+
configurableTabs?: ConfigurableTab[];
|
|
34
|
+
/**
|
|
35
|
+
* A set of tabs that may be 'pinned' by default, without the user adding them manually.
|
|
36
|
+
* Static tabs declared in personal scope are always pinned to the app's personal
|
|
37
|
+
* experience. Static tabs do not currently support the 'teams' scope.
|
|
38
|
+
*/
|
|
39
|
+
staticTabs?: StaticTab[];
|
|
40
|
+
/**
|
|
41
|
+
* The set of bots for this app. Currently only one bot per app is supported.
|
|
42
|
+
*/
|
|
43
|
+
bots?: Bot[];
|
|
44
|
+
/**
|
|
45
|
+
* The set of Office365 connectors for this app. Currently only one connector per app is
|
|
46
|
+
* supported.
|
|
47
|
+
*/
|
|
48
|
+
connectors?: Connector[];
|
|
49
|
+
/**
|
|
50
|
+
* Subscription offer associated with this app.
|
|
51
|
+
*/
|
|
52
|
+
subscriptionOffer?: SubscriptionOffer;
|
|
53
|
+
/**
|
|
54
|
+
* The set of compose extensions for this app. Currently only one compose extension per app
|
|
55
|
+
* is supported.
|
|
56
|
+
*/
|
|
57
|
+
composeExtensions?: ComposeExtension[];
|
|
58
|
+
/**
|
|
59
|
+
* Specifies the permissions the app requests from users.
|
|
60
|
+
*/
|
|
61
|
+
permissions?: Permission[];
|
|
62
|
+
/**
|
|
63
|
+
* Specify the native features on a user's device that your app may request access to.
|
|
64
|
+
*/
|
|
65
|
+
devicePermissions?: DevicePermission[];
|
|
66
|
+
/**
|
|
67
|
+
* A list of valid domains from which the tabs expect to load any content. Domain listings
|
|
68
|
+
* can include wildcards, for example `*.example.com`. If your tab configuration or content
|
|
69
|
+
* UI needs to navigate to any other domain besides the one use for tab configuration, that
|
|
70
|
+
* domain must be specified here.
|
|
71
|
+
*/
|
|
72
|
+
validDomains?: string[];
|
|
73
|
+
/**
|
|
74
|
+
* Specify your AAD App ID and Graph information to help users seamlessly sign into your AAD
|
|
75
|
+
* app.
|
|
76
|
+
*/
|
|
77
|
+
webApplicationInfo?: WebApplicationInfo;
|
|
78
|
+
/**
|
|
79
|
+
* Specify the app's Graph connector configuration. If this is present then
|
|
80
|
+
* webApplicationInfo.id must also be specified.
|
|
81
|
+
*/
|
|
82
|
+
graphConnector?: GraphConnector;
|
|
83
|
+
/**
|
|
84
|
+
* A value indicating whether or not show loading indicator when app/tab is loading
|
|
85
|
+
*/
|
|
86
|
+
showLoadingIndicator?: boolean;
|
|
87
|
+
/**
|
|
88
|
+
* A value indicating whether a personal app is rendered without a tab header-bar
|
|
89
|
+
*/
|
|
90
|
+
isFullScreen?: boolean;
|
|
91
|
+
activities?: Activities;
|
|
92
|
+
/**
|
|
93
|
+
* A list of tenant configured properties for an app
|
|
94
|
+
*/
|
|
95
|
+
configurableProperties?: ConfigurableProperty[];
|
|
96
|
+
/**
|
|
97
|
+
* List of 'non-standard' channel types that the app supports. Note: Channels of standard
|
|
98
|
+
* type are supported by default if the app supports team scope.
|
|
99
|
+
*/
|
|
100
|
+
supportedChannelTypes?: SupportedChannelType[];
|
|
101
|
+
/**
|
|
102
|
+
* A value indicating whether an app is blocked by default until admin allows it
|
|
103
|
+
*/
|
|
104
|
+
defaultBlockUntilAdminAction?: boolean;
|
|
105
|
+
/**
|
|
106
|
+
* The url to the page that provides additional app information for the admins
|
|
107
|
+
*/
|
|
108
|
+
publisherDocsUrl?: string;
|
|
109
|
+
/**
|
|
110
|
+
* The install scope defined for this app by default. This will be the option displayed on
|
|
111
|
+
* the button when a user tries to add the app
|
|
112
|
+
*/
|
|
113
|
+
defaultInstallScope?: DefaultInstallScope;
|
|
114
|
+
/**
|
|
115
|
+
* When a group install scope is selected, this will define the default capability when the
|
|
116
|
+
* user installs the app
|
|
117
|
+
*/
|
|
118
|
+
defaultGroupCapability?: DefaultGroupCapability;
|
|
119
|
+
/**
|
|
120
|
+
* Specify meeting extension definition.
|
|
121
|
+
*/
|
|
122
|
+
meetingExtensionDefinition?: MeetingExtensionDefinition;
|
|
123
|
+
/**
|
|
124
|
+
* Specify and consolidates authorization related information for the App.
|
|
125
|
+
*/
|
|
126
|
+
authorization?: TeamsManifestV1D23Authorization;
|
|
127
|
+
extensions?: ElementExtension[];
|
|
128
|
+
/**
|
|
129
|
+
* Defines the list of cards which could be pinned to dashboards that can provide summarized
|
|
130
|
+
* view of information relevant to user.
|
|
131
|
+
*/
|
|
132
|
+
dashboardCards?: DashboardCard[];
|
|
133
|
+
copilotAgents?: CopilotAgents;
|
|
134
|
+
/**
|
|
135
|
+
* The Intune-related properties for the app.
|
|
136
|
+
*/
|
|
137
|
+
intuneInfo?: IntuneInfo;
|
|
138
|
+
elementRelationshipSet?: ElementRelationshipSet;
|
|
139
|
+
/**
|
|
140
|
+
* Optional property containing background loading configuration. By opting in to this
|
|
141
|
+
* performance enhancement, your app is eligible to be loaded in the background in any
|
|
142
|
+
* Microsoft 365 application host that supports this feature.
|
|
143
|
+
*/
|
|
144
|
+
backgroundLoadConfiguration?: BackgroundLoadConfiguration;
|
|
145
|
+
}
|
|
146
|
+
export interface Activities {
|
|
147
|
+
/**
|
|
148
|
+
* Specify the types of activites that your app can post to a users activity feed
|
|
149
|
+
*/
|
|
150
|
+
activityTypes?: ActivityType[];
|
|
151
|
+
/**
|
|
152
|
+
* Specify the customized icons that your app can post to a users activity feed
|
|
153
|
+
*/
|
|
154
|
+
activityIcons?: ActivityIcon[];
|
|
155
|
+
}
|
|
156
|
+
export interface ActivityIcon {
|
|
157
|
+
/**
|
|
158
|
+
* Represents the unique icon ID.
|
|
159
|
+
*/
|
|
160
|
+
id: string;
|
|
161
|
+
/**
|
|
162
|
+
* Represents the relative path to the icon image. Image should be size 32x32.
|
|
163
|
+
*/
|
|
164
|
+
iconFile: string;
|
|
165
|
+
}
|
|
166
|
+
export interface ActivityType {
|
|
167
|
+
type: string;
|
|
168
|
+
description: string;
|
|
169
|
+
templateText: string;
|
|
170
|
+
/**
|
|
171
|
+
* An array containing valid icon IDs per activity type.
|
|
172
|
+
*/
|
|
173
|
+
allowedIconIds?: string[];
|
|
174
|
+
}
|
|
175
|
+
/**
|
|
176
|
+
* Specify and consolidates authorization related information for the App.
|
|
177
|
+
*/
|
|
178
|
+
export interface TeamsManifestV1D23Authorization {
|
|
179
|
+
/**
|
|
180
|
+
* List of permissions that the app needs to function.
|
|
181
|
+
*/
|
|
182
|
+
permissions?: Permissions;
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* List of permissions that the app needs to function.
|
|
186
|
+
*/
|
|
187
|
+
export interface Permissions {
|
|
188
|
+
/**
|
|
189
|
+
* Permissions that must be granted on a per resource instance basis.
|
|
190
|
+
*/
|
|
191
|
+
resourceSpecific?: ResourceSpecific[];
|
|
192
|
+
}
|
|
193
|
+
export interface ResourceSpecific {
|
|
194
|
+
/**
|
|
195
|
+
* The name of the resource-specific permission.
|
|
196
|
+
*/
|
|
197
|
+
name: string;
|
|
198
|
+
/**
|
|
199
|
+
* The type of the resource-specific permission: delegated vs application.
|
|
200
|
+
*/
|
|
201
|
+
type: ResourceSpecificType;
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* The type of the resource-specific permission: delegated vs application.
|
|
205
|
+
*/
|
|
206
|
+
export type ResourceSpecificType = "Application" | "Delegated";
|
|
207
|
+
/**
|
|
208
|
+
* Optional property containing background loading configuration. By opting in to this
|
|
209
|
+
* performance enhancement, your app is eligible to be loaded in the background in any
|
|
210
|
+
* Microsoft 365 application host that supports this feature.
|
|
211
|
+
*/
|
|
212
|
+
export interface BackgroundLoadConfiguration {
|
|
213
|
+
/**
|
|
214
|
+
* Optional property within backgroundLoadConfiguration containing tab settings for
|
|
215
|
+
* background loading.
|
|
216
|
+
*/
|
|
217
|
+
tabConfiguration?: TabConfiguration;
|
|
218
|
+
}
|
|
219
|
+
/**
|
|
220
|
+
* Optional property within backgroundLoadConfiguration containing tab settings for
|
|
221
|
+
* background loading.
|
|
222
|
+
*/
|
|
223
|
+
export interface TabConfiguration {
|
|
224
|
+
/**
|
|
225
|
+
* Required URL for background loading. This can be the same contentUrl from the staticTabs
|
|
226
|
+
* section or an alternative endpoint used for background loading.
|
|
227
|
+
*/
|
|
228
|
+
contentUrl: string;
|
|
229
|
+
}
|
|
230
|
+
export interface Bot {
|
|
231
|
+
/**
|
|
232
|
+
* The Microsoft App ID specified for the bot in the Bot Framework portal
|
|
233
|
+
* (https://dev.botframework.com/bots)
|
|
234
|
+
*/
|
|
235
|
+
botId: string;
|
|
236
|
+
configuration?: Configuration;
|
|
237
|
+
/**
|
|
238
|
+
* This value describes whether or not the bot utilizes a user hint to add the bot to a
|
|
239
|
+
* specific channel.
|
|
240
|
+
*/
|
|
241
|
+
needsChannelSelector?: boolean;
|
|
242
|
+
/**
|
|
243
|
+
* A value indicating whether or not the bot is a one-way notification only bot, as opposed
|
|
244
|
+
* to a conversational bot.
|
|
245
|
+
*/
|
|
246
|
+
isNotificationOnly?: boolean;
|
|
247
|
+
/**
|
|
248
|
+
* A value indicating whether the bot supports uploading/downloading of files.
|
|
249
|
+
*/
|
|
250
|
+
supportsFiles?: boolean;
|
|
251
|
+
/**
|
|
252
|
+
* A value indicating whether the bot supports audio calling.
|
|
253
|
+
*/
|
|
254
|
+
supportsCalling?: boolean;
|
|
255
|
+
/**
|
|
256
|
+
* A value indicating whether the bot supports video calling.
|
|
257
|
+
*/
|
|
258
|
+
supportsVideo?: boolean;
|
|
259
|
+
/**
|
|
260
|
+
* Specifies whether the bot offers an experience in the context of a channel in a team, in
|
|
261
|
+
* a group chat (groupChat), an experience scoped to an individual user alone (personal) OR
|
|
262
|
+
* within Copilot surfaces. These options are non-exclusive.
|
|
263
|
+
*/
|
|
264
|
+
scopes: CommandListScope[];
|
|
265
|
+
/**
|
|
266
|
+
* The list of commands that the bot supplies, including their usage, description, and the
|
|
267
|
+
* scope for which the commands are valid. A separate command list should be used for each
|
|
268
|
+
* scope.
|
|
269
|
+
*/
|
|
270
|
+
commandLists?: CommandList[];
|
|
271
|
+
requirementSet?: ElementRequirementSet;
|
|
272
|
+
/**
|
|
273
|
+
* System‑generated metadata. This information is maintained by Microsoft services and must
|
|
274
|
+
* not be modified manually.
|
|
275
|
+
*/
|
|
276
|
+
registrationInfo?: RegistrationInfo;
|
|
277
|
+
}
|
|
278
|
+
export interface CommandList {
|
|
279
|
+
/**
|
|
280
|
+
* Specifies the scopes for which the command list is valid
|
|
281
|
+
*/
|
|
282
|
+
scopes: CommandListScope[];
|
|
283
|
+
commands: CommandListCommand[];
|
|
284
|
+
}
|
|
285
|
+
export interface CommandListCommand {
|
|
286
|
+
/**
|
|
287
|
+
* The bot command name
|
|
288
|
+
*/
|
|
289
|
+
title: string;
|
|
290
|
+
/**
|
|
291
|
+
* A simple text description or an example of the command syntax and its arguments.
|
|
292
|
+
*/
|
|
293
|
+
description: string;
|
|
294
|
+
}
|
|
295
|
+
export type CommandListScope = "team" | "personal" | "groupChat" | "copilot";
|
|
296
|
+
export interface Configuration {
|
|
297
|
+
team?: Team;
|
|
298
|
+
groupChat?: Team;
|
|
299
|
+
}
|
|
300
|
+
export interface Team {
|
|
301
|
+
fetchTask?: boolean;
|
|
302
|
+
taskInfo?: TaskInfo;
|
|
303
|
+
}
|
|
304
|
+
export interface TaskInfo {
|
|
305
|
+
/**
|
|
306
|
+
* Initial dialog title
|
|
307
|
+
*/
|
|
308
|
+
title?: string;
|
|
309
|
+
/**
|
|
310
|
+
* Dialog width - either a number in pixels or default layout such as 'large', 'medium', or
|
|
311
|
+
* 'small'
|
|
312
|
+
*/
|
|
313
|
+
width?: string;
|
|
314
|
+
/**
|
|
315
|
+
* Dialog height - either a number in pixels or default layout such as 'large', 'medium', or
|
|
316
|
+
* 'small'
|
|
317
|
+
*/
|
|
318
|
+
height?: string;
|
|
319
|
+
/**
|
|
320
|
+
* Initial webview URL
|
|
321
|
+
*/
|
|
322
|
+
url?: string;
|
|
323
|
+
}
|
|
324
|
+
/**
|
|
325
|
+
* System‑generated metadata. This information is maintained by Microsoft services and must
|
|
326
|
+
* not be modified manually.
|
|
327
|
+
*/
|
|
328
|
+
export interface RegistrationInfo {
|
|
329
|
+
/**
|
|
330
|
+
* The partner source through which the bot is registered. System‑generated metadata. This
|
|
331
|
+
* information is maintained by Microsoft services and must not be modified manually.
|
|
332
|
+
*/
|
|
333
|
+
source: Source;
|
|
334
|
+
/**
|
|
335
|
+
* A Power Platform environment that serves as a container for building apps under a
|
|
336
|
+
* Microsoft 365 tenant and can only be accessed by users within that tenant.
|
|
337
|
+
* System‑generated metadata. This information is maintained by Microsoft services and must
|
|
338
|
+
* not be modified manually.
|
|
339
|
+
*/
|
|
340
|
+
environment?: string;
|
|
341
|
+
/**
|
|
342
|
+
* The Copilot Studio copilot schema name. System‑generated metadata. This information is
|
|
343
|
+
* maintained by Microsoft services and must not be modified manually.
|
|
344
|
+
*/
|
|
345
|
+
schemaName?: string;
|
|
346
|
+
/**
|
|
347
|
+
* The core services cluster category for Copilot Studio copilots. System‑generated
|
|
348
|
+
* metadata. This information is maintained by Microsoft services and must not be modified
|
|
349
|
+
* manually.
|
|
350
|
+
*/
|
|
351
|
+
clusterCategory?: string;
|
|
352
|
+
}
|
|
353
|
+
/**
|
|
354
|
+
* The partner source through which the bot is registered. System‑generated metadata. This
|
|
355
|
+
* information is maintained by Microsoft services and must not be modified manually.
|
|
356
|
+
*/
|
|
357
|
+
export type Source = "standard" | "microsoftCopilotStudio" | "onedriveSharepoint";
|
|
358
|
+
/**
|
|
359
|
+
* An object representing a set of requirements that the host must support for the element.
|
|
360
|
+
*/
|
|
361
|
+
export interface ElementRequirementSet {
|
|
362
|
+
hostMustSupportFunctionalities: HostFunctionality[];
|
|
363
|
+
}
|
|
364
|
+
/**
|
|
365
|
+
* An object representing a specific functionality that a host must support.
|
|
366
|
+
*/
|
|
367
|
+
export interface HostFunctionality {
|
|
368
|
+
/**
|
|
369
|
+
* The name of the functionality.
|
|
370
|
+
*/
|
|
371
|
+
name: HostMustSupportFunctionalityName;
|
|
372
|
+
}
|
|
373
|
+
/**
|
|
374
|
+
* The name of the functionality.
|
|
375
|
+
*/
|
|
376
|
+
export type HostMustSupportFunctionalityName = "dialogUrl" | "dialogUrlBot" | "dialogAdaptiveCard" | "dialogAdaptiveCardBot";
|
|
377
|
+
export interface ComposeExtension {
|
|
378
|
+
/**
|
|
379
|
+
* A unique identifier for the compose extension.
|
|
380
|
+
*/
|
|
381
|
+
id?: string;
|
|
382
|
+
/**
|
|
383
|
+
* The Microsoft App ID specified for the bot powering the compose extension in the Bot
|
|
384
|
+
* Framework portal (https://dev.botframework.com/bots)
|
|
385
|
+
*/
|
|
386
|
+
botId?: string;
|
|
387
|
+
/**
|
|
388
|
+
* Type of the compose extension.
|
|
389
|
+
*/
|
|
390
|
+
composeExtensionType?: ComposeExtensionType;
|
|
391
|
+
/**
|
|
392
|
+
* Object capturing authorization information.
|
|
393
|
+
*/
|
|
394
|
+
authorization?: ComposeExtensionAuthorization;
|
|
395
|
+
/**
|
|
396
|
+
* A relative file path to the api specification file in the manifest package.
|
|
397
|
+
*/
|
|
398
|
+
apiSpecificationFile?: string;
|
|
399
|
+
/**
|
|
400
|
+
* A value indicating whether the configuration of a compose extension can be updated by the
|
|
401
|
+
* user.
|
|
402
|
+
*/
|
|
403
|
+
canUpdateConfiguration?: boolean | null;
|
|
404
|
+
commands?: ComposeExtensionCommand[];
|
|
405
|
+
/**
|
|
406
|
+
* A list of handlers that allow apps to be invoked when certain conditions are met
|
|
407
|
+
*/
|
|
408
|
+
messageHandlers?: MessageHandler[];
|
|
409
|
+
requirementSet?: ElementRequirementSet;
|
|
410
|
+
}
|
|
411
|
+
/**
|
|
412
|
+
* Object capturing authorization information.
|
|
413
|
+
*/
|
|
414
|
+
export interface ComposeExtensionAuthorization {
|
|
415
|
+
/**
|
|
416
|
+
* Enum of possible authentication types.
|
|
417
|
+
*/
|
|
418
|
+
authType?: AuthType;
|
|
419
|
+
/**
|
|
420
|
+
* Object capturing details needed to do single aad auth flow. It will be only present when
|
|
421
|
+
* auth type is entraId.
|
|
422
|
+
*/
|
|
423
|
+
microsoftEntraConfiguration?: MicrosoftEntraConfiguration;
|
|
424
|
+
/**
|
|
425
|
+
* Object capturing details needed to do service auth. It will be only present when auth
|
|
426
|
+
* type is apiSecretServiceAuth.
|
|
427
|
+
*/
|
|
428
|
+
apiSecretServiceAuthConfiguration?: APISecretServiceAuthConfiguration;
|
|
429
|
+
}
|
|
430
|
+
/**
|
|
431
|
+
* Object capturing details needed to do service auth. It will be only present when auth
|
|
432
|
+
* type is apiSecretServiceAuth.
|
|
433
|
+
*/
|
|
434
|
+
export interface APISecretServiceAuthConfiguration {
|
|
435
|
+
/**
|
|
436
|
+
* Registration id returned when developer submits the api key through Developer Portal.
|
|
437
|
+
*/
|
|
438
|
+
apiSecretRegistrationId?: string;
|
|
439
|
+
}
|
|
440
|
+
/**
|
|
441
|
+
* Enum of possible authentication types.
|
|
442
|
+
*/
|
|
443
|
+
export type AuthType = "none" | "apiSecretServiceAuth" | "microsoftEntra";
|
|
444
|
+
/**
|
|
445
|
+
* Object capturing details needed to do single aad auth flow. It will be only present when
|
|
446
|
+
* auth type is entraId.
|
|
447
|
+
*/
|
|
448
|
+
export interface MicrosoftEntraConfiguration {
|
|
449
|
+
/**
|
|
450
|
+
* Boolean indicating whether single sign on is configured for the app.
|
|
451
|
+
*/
|
|
452
|
+
supportsSingleSignOn?: boolean;
|
|
453
|
+
}
|
|
454
|
+
export interface ComposeExtensionCommand {
|
|
455
|
+
/**
|
|
456
|
+
* Id of the command.
|
|
457
|
+
*/
|
|
458
|
+
id: string;
|
|
459
|
+
/**
|
|
460
|
+
* Type of the command
|
|
461
|
+
*/
|
|
462
|
+
type?: CommandType;
|
|
463
|
+
samplePrompts?: SamplePrompt[];
|
|
464
|
+
/**
|
|
465
|
+
* A relative file path for api response rendering template file.
|
|
466
|
+
*/
|
|
467
|
+
apiResponseRenderingTemplateFile?: string;
|
|
468
|
+
/**
|
|
469
|
+
* Context where the command would apply
|
|
470
|
+
*/
|
|
471
|
+
context?: CommandContext[];
|
|
472
|
+
/**
|
|
473
|
+
* Title of the command.
|
|
474
|
+
*/
|
|
475
|
+
title: string;
|
|
476
|
+
/**
|
|
477
|
+
* Description of the command.
|
|
478
|
+
*/
|
|
479
|
+
description?: string;
|
|
480
|
+
/**
|
|
481
|
+
* A boolean value that indicates if the command should be run once initially with no
|
|
482
|
+
* parameter.
|
|
483
|
+
*/
|
|
484
|
+
initialRun?: boolean;
|
|
485
|
+
/**
|
|
486
|
+
* A boolean value that indicates if it should fetch task module dynamically
|
|
487
|
+
*/
|
|
488
|
+
fetchTask?: boolean;
|
|
489
|
+
/**
|
|
490
|
+
* Semantic description for the command.
|
|
491
|
+
*/
|
|
492
|
+
semanticDescription?: string;
|
|
493
|
+
parameters?: Parameter[];
|
|
494
|
+
taskInfo?: TaskInfo;
|
|
495
|
+
}
|
|
496
|
+
export type CommandContext = "compose" | "commandBox" | "message";
|
|
497
|
+
export interface Parameter {
|
|
498
|
+
/**
|
|
499
|
+
* Name of the parameter.
|
|
500
|
+
*/
|
|
501
|
+
name: string;
|
|
502
|
+
/**
|
|
503
|
+
* Type of the parameter
|
|
504
|
+
*/
|
|
505
|
+
inputType?: InputType;
|
|
506
|
+
/**
|
|
507
|
+
* Title of the parameter.
|
|
508
|
+
*/
|
|
509
|
+
title: string;
|
|
510
|
+
/**
|
|
511
|
+
* Description of the parameter.
|
|
512
|
+
*/
|
|
513
|
+
description?: string;
|
|
514
|
+
/**
|
|
515
|
+
* Initial value for the parameter
|
|
516
|
+
*/
|
|
517
|
+
value?: string;
|
|
518
|
+
/**
|
|
519
|
+
* The value indicates if this parameter is a required field.
|
|
520
|
+
*/
|
|
521
|
+
isRequired?: boolean;
|
|
522
|
+
/**
|
|
523
|
+
* Semantic description for the parameter.
|
|
524
|
+
*/
|
|
525
|
+
semanticDescription?: string;
|
|
526
|
+
/**
|
|
527
|
+
* The choice options for the parameter
|
|
528
|
+
*/
|
|
529
|
+
choices?: Choice[];
|
|
530
|
+
}
|
|
531
|
+
export interface Choice {
|
|
532
|
+
/**
|
|
533
|
+
* Title of the choice
|
|
534
|
+
*/
|
|
535
|
+
title: string;
|
|
536
|
+
/**
|
|
537
|
+
* Value of the choice
|
|
538
|
+
*/
|
|
539
|
+
value: string;
|
|
540
|
+
}
|
|
541
|
+
/**
|
|
542
|
+
* Type of the parameter
|
|
543
|
+
*/
|
|
544
|
+
export type InputType = "text" | "textarea" | "number" | "date" | "time" | "toggle" | "choiceset";
|
|
545
|
+
export interface SamplePrompt {
|
|
546
|
+
/**
|
|
547
|
+
* This string will hold the sample prompt
|
|
548
|
+
*/
|
|
549
|
+
text: string;
|
|
550
|
+
}
|
|
551
|
+
/**
|
|
552
|
+
* Type of the command
|
|
553
|
+
*/
|
|
554
|
+
export type CommandType = "query" | "action";
|
|
555
|
+
/**
|
|
556
|
+
* Type of the compose extension.
|
|
557
|
+
*/
|
|
558
|
+
export type ComposeExtensionType = "botBased" | "apiBased";
|
|
559
|
+
export interface MessageHandler {
|
|
560
|
+
/**
|
|
561
|
+
* Type of the message handler
|
|
562
|
+
*/
|
|
563
|
+
type: "link";
|
|
564
|
+
value: Value;
|
|
565
|
+
}
|
|
566
|
+
/**
|
|
567
|
+
* Type of the message handler
|
|
568
|
+
*/
|
|
569
|
+
export interface Value {
|
|
570
|
+
/**
|
|
571
|
+
* A list of domains that the link message handler can register for, and when they are
|
|
572
|
+
* matched the app will be invoked
|
|
573
|
+
*/
|
|
574
|
+
domains?: string[];
|
|
575
|
+
/**
|
|
576
|
+
* A boolean that indicates whether the app's link message handler supports anonymous invoke
|
|
577
|
+
* flow.
|
|
578
|
+
*/
|
|
579
|
+
supportsAnonymizedPayloads?: boolean;
|
|
580
|
+
}
|
|
581
|
+
export type ConfigurableProperty = "name" | "shortDescription" | "longDescription" | "smallImageUrl" | "largeImageUrl" | "accentColor" | "developerUrl" | "privacyUrl" | "termsOfUseUrl";
|
|
582
|
+
export interface ConfigurableTab {
|
|
583
|
+
/**
|
|
584
|
+
* A unique identifier for the tab. This id must be unique within the app manifest.
|
|
585
|
+
*/
|
|
586
|
+
id?: string;
|
|
587
|
+
/**
|
|
588
|
+
* The url to use when configuring the tab.
|
|
589
|
+
*/
|
|
590
|
+
configurationUrl: string;
|
|
591
|
+
/**
|
|
592
|
+
* A value indicating whether an instance of the tab's configuration can be updated by the
|
|
593
|
+
* user after creation.
|
|
594
|
+
*/
|
|
595
|
+
canUpdateConfiguration?: boolean;
|
|
596
|
+
/**
|
|
597
|
+
* Specifies whether the tab offers an experience in the context of a channel in a team, in
|
|
598
|
+
* a 1:1 or group chat, or in an experience scoped to an individual user alone. These
|
|
599
|
+
* options are non-exclusive. Currently, configurable tabs are only supported in the teams
|
|
600
|
+
* and groupchats scopes.
|
|
601
|
+
*/
|
|
602
|
+
scopes: ConfigurableTabScope[];
|
|
603
|
+
/**
|
|
604
|
+
* The set of meetingSurfaceItem scopes that a tab belong to
|
|
605
|
+
*/
|
|
606
|
+
meetingSurfaces?: MeetingSurface[];
|
|
607
|
+
/**
|
|
608
|
+
* The set of contextItem scopes that a tab belong to
|
|
609
|
+
*/
|
|
610
|
+
context?: ConfigurableTabContext[];
|
|
611
|
+
/**
|
|
612
|
+
* A relative file path to a tab preview image for use in SharePoint. Size 1024x768.
|
|
613
|
+
*/
|
|
614
|
+
sharePointPreviewImage?: string;
|
|
615
|
+
/**
|
|
616
|
+
* Defines how your tab will be made available in SharePoint.
|
|
617
|
+
*/
|
|
618
|
+
supportedSharePointHosts?: SupportedSharePointHost[];
|
|
619
|
+
}
|
|
620
|
+
export type ConfigurableTabContext = "personalTab" | "channelTab" | "privateChatTab" | "meetingChatTab" | "meetingDetailsTab" | "meetingSidePanel" | "meetingStage";
|
|
621
|
+
export type MeetingSurface = "sidePanel" | "stage";
|
|
622
|
+
export type ConfigurableTabScope = "team" | "groupChat";
|
|
623
|
+
export type SupportedSharePointHost = "sharePointFullPage" | "sharePointWebPart";
|
|
624
|
+
export interface Connector {
|
|
625
|
+
/**
|
|
626
|
+
* A unique identifier for the connector which matches its ID in the Connectors Developer
|
|
627
|
+
* Portal.
|
|
628
|
+
*/
|
|
629
|
+
connectorId: string;
|
|
630
|
+
/**
|
|
631
|
+
* The url to use for configuring the connector using the inline configuration experience.
|
|
632
|
+
*/
|
|
633
|
+
configurationUrl?: string;
|
|
634
|
+
/**
|
|
635
|
+
* Specifies whether the connector offers an experience in the context of a channel in a
|
|
636
|
+
* team, or an experience scoped to an individual user alone. Currently, only the team scope
|
|
637
|
+
* is supported.
|
|
638
|
+
*/
|
|
639
|
+
scopes: "team"[];
|
|
640
|
+
}
|
|
641
|
+
export interface CopilotAgents {
|
|
642
|
+
/**
|
|
643
|
+
* An array of declarative agent elements references. Currently, only one declarative agent
|
|
644
|
+
* per application is supported.
|
|
645
|
+
*/
|
|
646
|
+
declarativeAgents?: DeclarativeAgentRef[];
|
|
647
|
+
/**
|
|
648
|
+
* An array of Custom Engine Agents. Currently only one Custom Engine Agent per application
|
|
649
|
+
* is supported. Support is currently in public preview.
|
|
650
|
+
*/
|
|
651
|
+
customEngineAgents?: CustomEngineAgent[];
|
|
652
|
+
}
|
|
653
|
+
export interface CustomEngineAgent {
|
|
654
|
+
/**
|
|
655
|
+
* The id of the Custom Engine Agent. If it is of type bot, the id must match the id
|
|
656
|
+
* specified in a bot in the bots node and the referenced bot must have personal scope. The
|
|
657
|
+
* app short name and short description must also be defined.
|
|
658
|
+
*/
|
|
659
|
+
id: string;
|
|
660
|
+
/**
|
|
661
|
+
* The type of the Custom Engine Agent. Currently only type bot is supported.
|
|
662
|
+
*/
|
|
663
|
+
type: "bot";
|
|
664
|
+
disclaimer?: Disclaimer;
|
|
665
|
+
}
|
|
666
|
+
export interface Disclaimer {
|
|
667
|
+
/**
|
|
668
|
+
* The message shown to users before they interact with this application.
|
|
669
|
+
*/
|
|
670
|
+
text: string;
|
|
671
|
+
[property: string]: any;
|
|
672
|
+
}
|
|
673
|
+
/**
|
|
674
|
+
* The type of the Custom Engine Agent. Currently only type bot is supported.
|
|
675
|
+
*
|
|
676
|
+
* The content of the dashboard card is sourced from a bot.
|
|
677
|
+
*/
|
|
678
|
+
/**
|
|
679
|
+
* A reference to a declarative agent element. The element's definition is in a separate
|
|
680
|
+
* file.
|
|
681
|
+
*/
|
|
682
|
+
export interface DeclarativeAgentRef {
|
|
683
|
+
/**
|
|
684
|
+
* A unique identifier for this declarative agent element.
|
|
685
|
+
*/
|
|
686
|
+
id: string;
|
|
687
|
+
/**
|
|
688
|
+
* Relative file path to this declarative agent element file in the application package.
|
|
689
|
+
*/
|
|
690
|
+
file: string;
|
|
691
|
+
}
|
|
692
|
+
/**
|
|
693
|
+
* Cards wich could be pinned to dashboard providing summarized view of information relevant
|
|
694
|
+
* to user.
|
|
695
|
+
*/
|
|
696
|
+
export interface DashboardCard {
|
|
697
|
+
/**
|
|
698
|
+
* Unique Id for the card. Must be unique inside the app.
|
|
699
|
+
*/
|
|
700
|
+
id: string;
|
|
701
|
+
/**
|
|
702
|
+
* Represents the name of the card. Maximum length is 255 characters.
|
|
703
|
+
*/
|
|
704
|
+
displayName: string;
|
|
705
|
+
/**
|
|
706
|
+
* Description of the card.Maximum length is 255 characters.
|
|
707
|
+
*/
|
|
708
|
+
description: string;
|
|
709
|
+
/**
|
|
710
|
+
* Id of the group in the card picker. This must be guid.
|
|
711
|
+
*/
|
|
712
|
+
pickerGroupId: string;
|
|
713
|
+
icon?: DashboardCardIcon;
|
|
714
|
+
contentSource: DashboardCardContentSource;
|
|
715
|
+
/**
|
|
716
|
+
* Rendering Size for dashboard card.
|
|
717
|
+
*/
|
|
718
|
+
defaultSize: DefaultSize;
|
|
719
|
+
}
|
|
720
|
+
/**
|
|
721
|
+
* Represents a configuration for the source of the card’s content.
|
|
722
|
+
*/
|
|
723
|
+
export interface DashboardCardContentSource {
|
|
724
|
+
/**
|
|
725
|
+
* The content of the dashboard card is sourced from a bot.
|
|
726
|
+
*/
|
|
727
|
+
sourceType?: "bot";
|
|
728
|
+
/**
|
|
729
|
+
* The configuration for the bot source. Required if sourceType is set to bot.
|
|
730
|
+
*/
|
|
731
|
+
botConfiguration?: BotConfiguration;
|
|
732
|
+
}
|
|
733
|
+
/**
|
|
734
|
+
* The configuration for the bot source. Required if sourceType is set to bot.
|
|
735
|
+
*/
|
|
736
|
+
export interface BotConfiguration {
|
|
737
|
+
/**
|
|
738
|
+
* The unique Microsoft app ID for the bot as registered with the Bot Framework.
|
|
739
|
+
*/
|
|
740
|
+
botId?: string;
|
|
741
|
+
}
|
|
742
|
+
/**
|
|
743
|
+
* Rendering Size for dashboard card.
|
|
744
|
+
*/
|
|
745
|
+
export type DefaultSize = "medium" | "large";
|
|
746
|
+
/**
|
|
747
|
+
* Represents a configuration for the source of the card’s content
|
|
748
|
+
*/
|
|
749
|
+
export interface DashboardCardIcon {
|
|
750
|
+
/**
|
|
751
|
+
* The icon for the card, to be displayed in the toolbox and card bar, represented as URL.
|
|
752
|
+
*/
|
|
753
|
+
iconUrl?: string;
|
|
754
|
+
/**
|
|
755
|
+
* Office UI Fabric/Fluent UI icon friendly name for the card. This value will be used if
|
|
756
|
+
* ‘iconUrl’ is not specified.
|
|
757
|
+
*/
|
|
758
|
+
officeUIFabricIconName?: string;
|
|
759
|
+
}
|
|
760
|
+
/**
|
|
761
|
+
* When a group install scope is selected, this will define the default capability when the
|
|
762
|
+
* user installs the app
|
|
763
|
+
*/
|
|
764
|
+
export interface DefaultGroupCapability {
|
|
765
|
+
/**
|
|
766
|
+
* When the install scope selected is Team, this field specifies the default capability
|
|
767
|
+
* available
|
|
768
|
+
*/
|
|
769
|
+
team?: Groupchat;
|
|
770
|
+
/**
|
|
771
|
+
* When the install scope selected is GroupChat, this field specifies the default capability
|
|
772
|
+
* available
|
|
773
|
+
*/
|
|
774
|
+
groupchat?: Groupchat;
|
|
775
|
+
/**
|
|
776
|
+
* When the install scope selected is Meetings, this field specifies the default capability
|
|
777
|
+
* available
|
|
778
|
+
*/
|
|
779
|
+
meetings?: Groupchat;
|
|
780
|
+
}
|
|
781
|
+
/**
|
|
782
|
+
* When the install scope selected is GroupChat, this field specifies the default capability
|
|
783
|
+
* available
|
|
784
|
+
*
|
|
785
|
+
* When the install scope selected is Meetings, this field specifies the default capability
|
|
786
|
+
* available
|
|
787
|
+
*
|
|
788
|
+
* When the install scope selected is Team, this field specifies the default capability
|
|
789
|
+
* available
|
|
790
|
+
*/
|
|
791
|
+
export type Groupchat = "tab" | "bot" | "connector";
|
|
792
|
+
/**
|
|
793
|
+
* The install scope defined for this app by default. This will be the option displayed on
|
|
794
|
+
* the button when a user tries to add the app
|
|
795
|
+
*/
|
|
796
|
+
export type DefaultInstallScope = "personal" | "team" | "groupChat" | "meetings" | "copilot";
|
|
797
|
+
export interface Description {
|
|
798
|
+
/**
|
|
799
|
+
* A short description of the app used when space is limited. Maximum length is 80
|
|
800
|
+
* characters.
|
|
801
|
+
*/
|
|
802
|
+
short: string;
|
|
803
|
+
/**
|
|
804
|
+
* The full description of the app. Maximum length is 4000 characters.
|
|
805
|
+
*/
|
|
806
|
+
full: string;
|
|
807
|
+
}
|
|
808
|
+
export interface Developer {
|
|
809
|
+
/**
|
|
810
|
+
* The display name for the developer.
|
|
811
|
+
*/
|
|
812
|
+
name: string;
|
|
813
|
+
/**
|
|
814
|
+
* The Microsoft Partner Network ID that identifies the partner organization building the
|
|
815
|
+
* app. This field is not required, and should only be used if you are already part of the
|
|
816
|
+
* Microsoft Partner Network. More info at https://aka.ms/partner
|
|
817
|
+
*/
|
|
818
|
+
mpnId?: string;
|
|
819
|
+
/**
|
|
820
|
+
* The url to the page that provides support information for the app.
|
|
821
|
+
*/
|
|
822
|
+
websiteUrl: string;
|
|
823
|
+
/**
|
|
824
|
+
* The url to the page that provides privacy information for the app.
|
|
825
|
+
*/
|
|
826
|
+
privacyUrl: string;
|
|
827
|
+
/**
|
|
828
|
+
* The url to the page that provides the terms of use for the app.
|
|
829
|
+
*/
|
|
830
|
+
termsOfUseUrl: string;
|
|
831
|
+
}
|
|
832
|
+
export type DevicePermission = "geolocation" | "media" | "notifications" | "midi" | "openExternal";
|
|
833
|
+
export interface ElementRelationshipSet {
|
|
834
|
+
/**
|
|
835
|
+
* An array containing multiple instances of unidirectional dependency relationships (each
|
|
836
|
+
* represented by a oneWayDependency object).
|
|
837
|
+
*/
|
|
838
|
+
oneWayDependencies?: OneWayDependency[];
|
|
839
|
+
/**
|
|
840
|
+
* An array containing multiple instances of mutual dependency relationships between
|
|
841
|
+
* elements (each represented by a mutualDependency object).
|
|
842
|
+
*/
|
|
843
|
+
mutualDependencies?: Array<ElementReference[]>;
|
|
844
|
+
}
|
|
845
|
+
/**
|
|
846
|
+
* A specific instance of mutual dependency between two or more elements, indicating that
|
|
847
|
+
* each element depends on the others in a bidirectional manner.
|
|
848
|
+
*/
|
|
849
|
+
export interface ElementReference {
|
|
850
|
+
name: MutualDependencyName;
|
|
851
|
+
id: string;
|
|
852
|
+
commandIds?: string[];
|
|
853
|
+
}
|
|
854
|
+
export type MutualDependencyName = "bots" | "staticTabs" | "composeExtensions" | "configurableTabs";
|
|
855
|
+
/**
|
|
856
|
+
* An object representing a unidirectional dependency relationship, where one specific
|
|
857
|
+
* element (referred to as the `element`) relies on an array of other elements (referred to
|
|
858
|
+
* as the `dependsOn`) in a single direction.
|
|
859
|
+
*/
|
|
860
|
+
export interface OneWayDependency {
|
|
861
|
+
element: ElementReference;
|
|
862
|
+
dependsOn: ElementReference[];
|
|
863
|
+
}
|
|
864
|
+
/**
|
|
865
|
+
* The set of extensions for this app. Currently only one extensions per app is supported.
|
|
866
|
+
*/
|
|
867
|
+
export interface ElementExtension {
|
|
868
|
+
requirements?: RequirementsExtensionElement;
|
|
869
|
+
runtimes?: ExtensionRuntimesArray[];
|
|
870
|
+
ribbons?: ExtensionRibbonsArray[];
|
|
871
|
+
autoRunEvents?: ExtensionAutoRunEventsArray[];
|
|
872
|
+
alternates?: ExtensionAlternateVersionsArray[];
|
|
873
|
+
contentRuntimes?: ExtensionContentRuntimeArray[];
|
|
874
|
+
getStartedMessages?: ExtensionGetStartedMessageArray[];
|
|
875
|
+
contextMenus?: ExtensionContextMenuArray[];
|
|
876
|
+
keyboardShortcuts?: ExtensionKeyboardShortcut[];
|
|
877
|
+
/**
|
|
878
|
+
* The url for your extension, used to validate Exchange user identity tokens.
|
|
879
|
+
*/
|
|
880
|
+
audienceClaimUrl?: string;
|
|
881
|
+
}
|
|
882
|
+
export interface ExtensionAlternateVersionsArray {
|
|
883
|
+
requirements?: RequirementsExtensionElement;
|
|
884
|
+
prefer?: Prefer;
|
|
885
|
+
hide?: Hide;
|
|
886
|
+
alternateIcons?: AlternateIcons;
|
|
887
|
+
}
|
|
888
|
+
export interface AlternateIcons {
|
|
889
|
+
icon: ExtensionCommonIcon;
|
|
890
|
+
highResolutionIcon: ExtensionCommonIcon;
|
|
891
|
+
}
|
|
892
|
+
export interface ExtensionCommonIcon {
|
|
893
|
+
/**
|
|
894
|
+
* Size in pixels of the icon. Three image sizes are required (16, 32, and 80 pixels)
|
|
895
|
+
*/
|
|
896
|
+
size: number;
|
|
897
|
+
/**
|
|
898
|
+
* Absolute Url to the icon.
|
|
899
|
+
*/
|
|
900
|
+
url: string;
|
|
901
|
+
}
|
|
902
|
+
export interface Hide {
|
|
903
|
+
storeOfficeAddin?: StoreOfficeAddin;
|
|
904
|
+
customOfficeAddin?: CustomOfficeAddin;
|
|
905
|
+
[property: string]: any;
|
|
906
|
+
}
|
|
907
|
+
export interface CustomOfficeAddin {
|
|
908
|
+
/**
|
|
909
|
+
* Solution ID of the in-market add-in to hide. Maximum length is 64 characters.
|
|
910
|
+
*/
|
|
911
|
+
officeAddinId: string;
|
|
912
|
+
}
|
|
913
|
+
export interface StoreOfficeAddin {
|
|
914
|
+
/**
|
|
915
|
+
* Solution ID of an in-market add-in to hide. Maximum length is 64 characters.
|
|
916
|
+
*/
|
|
917
|
+
officeAddinId: string;
|
|
918
|
+
/**
|
|
919
|
+
* Asset ID of the in-market add-in to hide. Maximum length is 64 characters.
|
|
920
|
+
*/
|
|
921
|
+
assetId: string;
|
|
922
|
+
}
|
|
923
|
+
export interface Prefer {
|
|
924
|
+
comAddin?: COMAddin;
|
|
925
|
+
xllCustomFunctions?: ExtensionXllCustomFunctions;
|
|
926
|
+
[property: string]: any;
|
|
927
|
+
}
|
|
928
|
+
export interface COMAddin {
|
|
929
|
+
/**
|
|
930
|
+
* Program ID of the alternate com extension. Maximum length is 64 characters.
|
|
931
|
+
*/
|
|
932
|
+
progId: string;
|
|
933
|
+
}
|
|
934
|
+
export interface ExtensionXllCustomFunctions {
|
|
935
|
+
fileName?: string;
|
|
936
|
+
[property: string]: any;
|
|
937
|
+
}
|
|
938
|
+
/**
|
|
939
|
+
* Specifies limitations on which clients the add-in can be installed on, including
|
|
940
|
+
* limitations on the Office host application, the form factors, and the requirement sets
|
|
941
|
+
* that the client must support.
|
|
942
|
+
*
|
|
943
|
+
* Specifies the Office requirement sets.
|
|
944
|
+
*/
|
|
945
|
+
export interface RequirementsExtensionElement {
|
|
946
|
+
capabilities?: Capability[];
|
|
947
|
+
/**
|
|
948
|
+
* Identifies the scopes in which the add-in can run. Supported values: 'mail', 'workbook',
|
|
949
|
+
* 'document', 'presentation'.
|
|
950
|
+
*/
|
|
951
|
+
scopes?: RequirementsScope[];
|
|
952
|
+
/**
|
|
953
|
+
* Identifies the form factors that support the add-in. Supported values: mobile, desktop.
|
|
954
|
+
*/
|
|
955
|
+
formFactors?: FormFactor[];
|
|
956
|
+
}
|
|
957
|
+
export interface Capability {
|
|
958
|
+
/**
|
|
959
|
+
* Identifies the name of the requirement sets that the add-in needs to run.
|
|
960
|
+
*/
|
|
961
|
+
name: string;
|
|
962
|
+
/**
|
|
963
|
+
* Identifies the minimum version for the requirement sets that the add-in needs to run.
|
|
964
|
+
*/
|
|
965
|
+
minVersion?: string;
|
|
966
|
+
/**
|
|
967
|
+
* Identifies the maximum version for the requirement sets that the add-in needs to run.
|
|
968
|
+
*/
|
|
969
|
+
maxVersion?: string;
|
|
970
|
+
}
|
|
971
|
+
export type FormFactor = "desktop" | "mobile";
|
|
972
|
+
export type RequirementsScope = "mail" | "workbook" | "document" | "presentation";
|
|
973
|
+
export interface ExtensionAutoRunEventsArray {
|
|
974
|
+
requirements?: RequirementsExtensionElement;
|
|
975
|
+
/**
|
|
976
|
+
* Specifies the type of event. For supported types, please see:
|
|
977
|
+
* https://learn.microsoft.com/en-us/office/dev/add-ins/outlook/autolaunch?tabs=xmlmanifest#supported-events.
|
|
978
|
+
*/
|
|
979
|
+
events: Event[];
|
|
980
|
+
}
|
|
981
|
+
export interface Event {
|
|
982
|
+
type: string;
|
|
983
|
+
/**
|
|
984
|
+
* The ID of an action defined in runtimes. Maximum length is 64 characters.
|
|
985
|
+
*/
|
|
986
|
+
actionId: string;
|
|
987
|
+
/**
|
|
988
|
+
* Configures how Outlook responds to the event.
|
|
989
|
+
*/
|
|
990
|
+
options?: Options;
|
|
991
|
+
}
|
|
992
|
+
/**
|
|
993
|
+
* Configures how Outlook responds to the event.
|
|
994
|
+
*/
|
|
995
|
+
export interface Options {
|
|
996
|
+
sendMode: SendMode;
|
|
997
|
+
}
|
|
998
|
+
export type SendMode = "promptUser" | "softBlock" | "block";
|
|
999
|
+
/**
|
|
1000
|
+
* Content runtime is for 'ContentApp', which can be embedded directly into Excel or
|
|
1001
|
+
* PowerPoint documents.
|
|
1002
|
+
*/
|
|
1003
|
+
export interface ExtensionContentRuntimeArray {
|
|
1004
|
+
/**
|
|
1005
|
+
* Specifies the Office requirement sets for content add-in runtime. If the user's Office
|
|
1006
|
+
* version doesn't support the specified requirements, the component will not be available
|
|
1007
|
+
* in that client.
|
|
1008
|
+
*/
|
|
1009
|
+
requirements?: ContentRuntimeRequirements;
|
|
1010
|
+
/**
|
|
1011
|
+
* A unique identifier for this runtime within the app. This is developer specified.
|
|
1012
|
+
*/
|
|
1013
|
+
id: string;
|
|
1014
|
+
/**
|
|
1015
|
+
* Specifies the location of code for this runtime. Depending on the runtime.type, add-ins
|
|
1016
|
+
* use either a JavaScript file or an HTML page with an embedded <script> tag that specifies
|
|
1017
|
+
* the URL of a JavaScript file.
|
|
1018
|
+
*/
|
|
1019
|
+
code: ExtensionRuntimeCode;
|
|
1020
|
+
/**
|
|
1021
|
+
* The desired height in pixels for the initial content placeholder. This value MUST be
|
|
1022
|
+
* between 32 and 1000 pixels. Default value will be determined by host.
|
|
1023
|
+
*/
|
|
1024
|
+
requestedHeight?: number;
|
|
1025
|
+
/**
|
|
1026
|
+
* The desired width in pixels for the initial content placeholder. This value MUST be
|
|
1027
|
+
* between 32 and 1000 pixels. Default value will be determined by host.
|
|
1028
|
+
*/
|
|
1029
|
+
requestedWidth?: number;
|
|
1030
|
+
/**
|
|
1031
|
+
* Specifies whether a snapshot image of your content add-in is saved with the host
|
|
1032
|
+
* document. Default value is false. Set true to disable.
|
|
1033
|
+
*/
|
|
1034
|
+
disableSnapshot?: boolean;
|
|
1035
|
+
}
|
|
1036
|
+
/**
|
|
1037
|
+
* Specifies the location of code for this runtime. Depending on the runtime.type, add-ins
|
|
1038
|
+
* use either a JavaScript file or an HTML page with an embedded <script> tag that specifies
|
|
1039
|
+
* the URL of a JavaScript file.
|
|
1040
|
+
*/
|
|
1041
|
+
export interface ExtensionRuntimeCode {
|
|
1042
|
+
/**
|
|
1043
|
+
* URL of the .html page to be loaded in browser-based runtimes.
|
|
1044
|
+
*/
|
|
1045
|
+
page: string;
|
|
1046
|
+
/**
|
|
1047
|
+
* URL of the .js script file to be loaded in UI-less runtimes.
|
|
1048
|
+
*/
|
|
1049
|
+
script?: string;
|
|
1050
|
+
}
|
|
1051
|
+
/**
|
|
1052
|
+
* Specifies the Office requirement sets for content add-in runtime. If the user's Office
|
|
1053
|
+
* version doesn't support the specified requirements, the component will not be available
|
|
1054
|
+
* in that client.
|
|
1055
|
+
*
|
|
1056
|
+
* Specifies limitations on which clients the add-in can be installed on, including
|
|
1057
|
+
* limitations on the Office host application, the form factors, and the requirement sets
|
|
1058
|
+
* that the client must support.
|
|
1059
|
+
*
|
|
1060
|
+
* Specifies the Office requirement sets.
|
|
1061
|
+
*/
|
|
1062
|
+
export interface ContentRuntimeRequirements {
|
|
1063
|
+
capabilities?: Capability[];
|
|
1064
|
+
/**
|
|
1065
|
+
* Identifies the scopes in which the add-in can run. Supported values: 'mail', 'workbook',
|
|
1066
|
+
* 'document', 'presentation'.
|
|
1067
|
+
*/
|
|
1068
|
+
scopes?: RequirementsScope[];
|
|
1069
|
+
/**
|
|
1070
|
+
* Identifies the form factors that support the add-in. Supported values: mobile, desktop.
|
|
1071
|
+
*/
|
|
1072
|
+
formFactors?: FormFactor[];
|
|
1073
|
+
}
|
|
1074
|
+
/**
|
|
1075
|
+
* Specifies the context menus for your extension. A context menu is a shortcut menu that
|
|
1076
|
+
* appears when a user right-clicks (selects and holds) in the Office UI. Minimum size is 1.
|
|
1077
|
+
*/
|
|
1078
|
+
export interface ExtensionContextMenuArray {
|
|
1079
|
+
requirements?: ContextMenuRequirements;
|
|
1080
|
+
/**
|
|
1081
|
+
* Configures the context menus. Minimum size is 1.
|
|
1082
|
+
*/
|
|
1083
|
+
menus: ExtensionMenuItem[];
|
|
1084
|
+
}
|
|
1085
|
+
/**
|
|
1086
|
+
* Configures the context menus. Minimum size is 1.
|
|
1087
|
+
*
|
|
1088
|
+
* The title used for the top of the callout.
|
|
1089
|
+
*/
|
|
1090
|
+
export interface ExtensionMenuItem {
|
|
1091
|
+
/**
|
|
1092
|
+
* Use 'text' or 'cell' here for Office context menu. Use 'text' if the context menu should
|
|
1093
|
+
* open when a user right-clicks (selects and holds) on the selected text. Use 'cell' if the
|
|
1094
|
+
* context menu should open when the user right-clicks (selects and holds) on a cell in an
|
|
1095
|
+
* Excel spreadsheet.
|
|
1096
|
+
*/
|
|
1097
|
+
entryPoint: EntryPoint;
|
|
1098
|
+
controls: ExtensionCommonCustomGroupControlsItem[];
|
|
1099
|
+
}
|
|
1100
|
+
/**
|
|
1101
|
+
* The control type should be 'menu'. Minimum size is 1.
|
|
1102
|
+
*/
|
|
1103
|
+
export interface ExtensionCommonCustomGroupControlsItem {
|
|
1104
|
+
/**
|
|
1105
|
+
* A unique identifier for this control within the app. Maximum length is 64 characters.
|
|
1106
|
+
*/
|
|
1107
|
+
id: string;
|
|
1108
|
+
/**
|
|
1109
|
+
* Defines the type of control whether button or menu.
|
|
1110
|
+
*/
|
|
1111
|
+
type: PurpleType;
|
|
1112
|
+
/**
|
|
1113
|
+
* Id of an existing office control. Maximum length is 64 characters.
|
|
1114
|
+
*/
|
|
1115
|
+
builtInControlId?: string;
|
|
1116
|
+
/**
|
|
1117
|
+
* Displayed text for the control. Maximum length is 64 characters.
|
|
1118
|
+
*/
|
|
1119
|
+
label: string;
|
|
1120
|
+
/**
|
|
1121
|
+
* Configures the icons for the custom control.
|
|
1122
|
+
*/
|
|
1123
|
+
icons: ExtensionCommonIcon[];
|
|
1124
|
+
supertip: ExtensionCommonSuperToolTip;
|
|
1125
|
+
/**
|
|
1126
|
+
* The ID of an execution-type action that handles this key combination. Maximum length is
|
|
1127
|
+
* 64 characters.
|
|
1128
|
+
*/
|
|
1129
|
+
actionId?: string;
|
|
1130
|
+
/**
|
|
1131
|
+
* Specifies whether a group, button, menu, or menu item will be hidden on application and
|
|
1132
|
+
* platform combinations that support the API (Office.ribbon.requestCreateControls) that
|
|
1133
|
+
* installs custom contextual tabs on the ribbon. Default is false.
|
|
1134
|
+
*/
|
|
1135
|
+
overriddenByRibbonApi?: boolean;
|
|
1136
|
+
/**
|
|
1137
|
+
* Whether the control is initially enabled.
|
|
1138
|
+
*/
|
|
1139
|
+
enabled?: boolean;
|
|
1140
|
+
/**
|
|
1141
|
+
* Configures the items for a menu control.
|
|
1142
|
+
*/
|
|
1143
|
+
items?: ExtensionCommonCustomControlMenuItem[];
|
|
1144
|
+
}
|
|
1145
|
+
export interface ExtensionCommonCustomControlMenuItem {
|
|
1146
|
+
/**
|
|
1147
|
+
* A unique identifier for this control within the app. Maximum length is 64 characters.
|
|
1148
|
+
*/
|
|
1149
|
+
id: string;
|
|
1150
|
+
/**
|
|
1151
|
+
* Supported values: menuItem.
|
|
1152
|
+
*/
|
|
1153
|
+
type: "menuItem";
|
|
1154
|
+
/**
|
|
1155
|
+
* Displayed text for the control. Maximum length is 64 characters.
|
|
1156
|
+
*/
|
|
1157
|
+
label: string;
|
|
1158
|
+
icons?: ExtensionCommonIcon[];
|
|
1159
|
+
supertip: ExtensionCommonSuperToolTip;
|
|
1160
|
+
/**
|
|
1161
|
+
* The ID of an action defined in runtimes. Maximum length is 64 characters.
|
|
1162
|
+
*/
|
|
1163
|
+
actionId: string;
|
|
1164
|
+
/**
|
|
1165
|
+
* Whether the control is initially enabled.
|
|
1166
|
+
*/
|
|
1167
|
+
enabled?: boolean;
|
|
1168
|
+
overriddenByRibbonApi?: boolean;
|
|
1169
|
+
}
|
|
1170
|
+
export interface ExtensionCommonSuperToolTip {
|
|
1171
|
+
/**
|
|
1172
|
+
* Title text of the super tip. Maximum length is 64 characters.
|
|
1173
|
+
*/
|
|
1174
|
+
title: string;
|
|
1175
|
+
/**
|
|
1176
|
+
* Description of the super tip. Maximum length is 250 characters.
|
|
1177
|
+
*/
|
|
1178
|
+
description: string;
|
|
1179
|
+
}
|
|
1180
|
+
/**
|
|
1181
|
+
* Supported values: menuItem.
|
|
1182
|
+
*/
|
|
1183
|
+
/**
|
|
1184
|
+
* Defines the type of control whether button or menu.
|
|
1185
|
+
*/
|
|
1186
|
+
export type PurpleType = "button" | "menu";
|
|
1187
|
+
/**
|
|
1188
|
+
* Use 'text' or 'cell' here for Office context menu. Use 'text' if the context menu should
|
|
1189
|
+
* open when a user right-clicks (selects and holds) on the selected text. Use 'cell' if the
|
|
1190
|
+
* context menu should open when the user right-clicks (selects and holds) on a cell in an
|
|
1191
|
+
* Excel spreadsheet.
|
|
1192
|
+
*/
|
|
1193
|
+
export type EntryPoint = "text" | "cell";
|
|
1194
|
+
/**
|
|
1195
|
+
* Specifies limitations on which clients the add-in can be installed on, including
|
|
1196
|
+
* limitations on the Office host application, the form factors, and the requirement sets
|
|
1197
|
+
* that the client must support.
|
|
1198
|
+
*
|
|
1199
|
+
* Specifies the Office requirement sets.
|
|
1200
|
+
*/
|
|
1201
|
+
export interface ContextMenuRequirements {
|
|
1202
|
+
capabilities?: Capability[];
|
|
1203
|
+
/**
|
|
1204
|
+
* Identifies the scopes in which the add-in can run. Supported values: 'mail', 'workbook',
|
|
1205
|
+
* 'document', 'presentation'.
|
|
1206
|
+
*/
|
|
1207
|
+
scopes?: RequirementsScope[];
|
|
1208
|
+
/**
|
|
1209
|
+
* Identifies the form factors that support the add-in. Supported values: mobile, desktop.
|
|
1210
|
+
*/
|
|
1211
|
+
formFactors?: FormFactor[];
|
|
1212
|
+
}
|
|
1213
|
+
/**
|
|
1214
|
+
* Provides information used by the callout that appears when the add-in is installed.
|
|
1215
|
+
* Minimum size is 1. Maximum size is 3.
|
|
1216
|
+
*/
|
|
1217
|
+
export interface ExtensionGetStartedMessageArray {
|
|
1218
|
+
requirements?: GetStartedMessageRequirements;
|
|
1219
|
+
/**
|
|
1220
|
+
* The title used for the top of the callout.
|
|
1221
|
+
*/
|
|
1222
|
+
title: string;
|
|
1223
|
+
/**
|
|
1224
|
+
* The description/body content for the callout.
|
|
1225
|
+
*/
|
|
1226
|
+
description: string;
|
|
1227
|
+
/**
|
|
1228
|
+
* A URL to a page that explains the add-in in detail.
|
|
1229
|
+
*/
|
|
1230
|
+
learnMoreUrl: string;
|
|
1231
|
+
}
|
|
1232
|
+
/**
|
|
1233
|
+
* Specifies limitations on which clients the add-in can be installed on, including
|
|
1234
|
+
* limitations on the Office host application, the form factors, and the requirement sets
|
|
1235
|
+
* that the client must support.
|
|
1236
|
+
*
|
|
1237
|
+
* Specifies the Office requirement sets.
|
|
1238
|
+
*/
|
|
1239
|
+
export interface GetStartedMessageRequirements {
|
|
1240
|
+
capabilities?: Capability[];
|
|
1241
|
+
/**
|
|
1242
|
+
* Identifies the scopes in which the add-in can run. Supported values: 'mail', 'workbook',
|
|
1243
|
+
* 'document', 'presentation'.
|
|
1244
|
+
*/
|
|
1245
|
+
scopes?: RequirementsScope[];
|
|
1246
|
+
/**
|
|
1247
|
+
* Identifies the form factors that support the add-in. Supported values: mobile, desktop.
|
|
1248
|
+
*/
|
|
1249
|
+
formFactors?: FormFactor[];
|
|
1250
|
+
}
|
|
1251
|
+
export interface ExtensionKeyboardShortcut {
|
|
1252
|
+
/**
|
|
1253
|
+
* Specifies the Office requirement sets.
|
|
1254
|
+
*/
|
|
1255
|
+
requirements?: RequirementsExtensionElement;
|
|
1256
|
+
/**
|
|
1257
|
+
* Array of mappings from actions to the key combinations that invoke the actions.
|
|
1258
|
+
*/
|
|
1259
|
+
shortcuts: ExtensionShortcut[];
|
|
1260
|
+
[property: string]: any;
|
|
1261
|
+
}
|
|
1262
|
+
export interface ExtensionShortcut {
|
|
1263
|
+
key: Key;
|
|
1264
|
+
/**
|
|
1265
|
+
* The ID of an execution-type action that handles this key combination.
|
|
1266
|
+
*/
|
|
1267
|
+
actionId: string;
|
|
1268
|
+
[property: string]: any;
|
|
1269
|
+
}
|
|
1270
|
+
/**
|
|
1271
|
+
* Key combinations in different platform (i.e. default, windows, web and mac).
|
|
1272
|
+
*/
|
|
1273
|
+
export interface Key {
|
|
1274
|
+
/**
|
|
1275
|
+
* Fallback key for any platform that isn't specified.
|
|
1276
|
+
*/
|
|
1277
|
+
default: string;
|
|
1278
|
+
/**
|
|
1279
|
+
* key for mac platform. Alt is mapped to the Option key.
|
|
1280
|
+
*/
|
|
1281
|
+
mac?: string;
|
|
1282
|
+
/**
|
|
1283
|
+
* key for web platform.
|
|
1284
|
+
*/
|
|
1285
|
+
web?: string;
|
|
1286
|
+
/**
|
|
1287
|
+
* key for windows platform. Command is mapped to the Ctrl key.
|
|
1288
|
+
*/
|
|
1289
|
+
windows?: string;
|
|
1290
|
+
[property: string]: any;
|
|
1291
|
+
}
|
|
1292
|
+
export interface ExtensionRibbonsArray {
|
|
1293
|
+
requirements?: RequirementsExtensionElement;
|
|
1294
|
+
contexts?: ExtensionContext[];
|
|
1295
|
+
tabs: ExtensionRibbonsArrayTabsItem[];
|
|
1296
|
+
fixedControls?: ExtensionRibbonsArrayFixedControlItem[];
|
|
1297
|
+
spamPreProcessingDialog?: ExtensionRibbonsSpamPreProcessingDialog;
|
|
1298
|
+
}
|
|
1299
|
+
/**
|
|
1300
|
+
* Specifies the Office application windows in which the ribbon customization is available
|
|
1301
|
+
* to the user. Each item in the array is a member of a string array. Possible values are:
|
|
1302
|
+
* mailRead, mailCompose, meetingDetailsOrganizer, meetingDetailsAttendee,
|
|
1303
|
+
* onlineMeetingDetailsOrganizer, logEventMeetingDetailsAttendee, spamReportingOverride.
|
|
1304
|
+
*/
|
|
1305
|
+
export type ExtensionContext = "mailRead" | "mailCompose" | "meetingDetailsOrganizer" | "meetingDetailsAttendee" | "onlineMeetingDetailsOrganizer" | "logEventMeetingDetailsAttendee" | "default" | "spamReportingOverride";
|
|
1306
|
+
export interface ExtensionRibbonsArrayFixedControlItem {
|
|
1307
|
+
/**
|
|
1308
|
+
* A unique identifier for this control within the app. Maximum length is 64 characters.
|
|
1309
|
+
*/
|
|
1310
|
+
id: string;
|
|
1311
|
+
/**
|
|
1312
|
+
* Defines the type of control.
|
|
1313
|
+
*/
|
|
1314
|
+
type: "button";
|
|
1315
|
+
/**
|
|
1316
|
+
* Displayed text for the control. Maximum length is 64 characters.
|
|
1317
|
+
*/
|
|
1318
|
+
label: string;
|
|
1319
|
+
icons: ExtensionCommonIcon[];
|
|
1320
|
+
supertip: ExtensionCommonSuperToolTip;
|
|
1321
|
+
/**
|
|
1322
|
+
* The ID of an execution-type action that handles this key combination. Maximum length is
|
|
1323
|
+
* 64 characters.
|
|
1324
|
+
*/
|
|
1325
|
+
actionId: string;
|
|
1326
|
+
/**
|
|
1327
|
+
* Whether the control is initially enabled.
|
|
1328
|
+
*/
|
|
1329
|
+
enabled: boolean;
|
|
1330
|
+
}
|
|
1331
|
+
/**
|
|
1332
|
+
* Defines the type of control.
|
|
1333
|
+
*/
|
|
1334
|
+
export interface ExtensionRibbonsSpamPreProcessingDialog {
|
|
1335
|
+
/**
|
|
1336
|
+
* Specifies the custom title of the preprocessing dialog.
|
|
1337
|
+
*/
|
|
1338
|
+
title: string;
|
|
1339
|
+
/**
|
|
1340
|
+
* Specifies the custom text that appears in the preprocessing dialog.
|
|
1341
|
+
*/
|
|
1342
|
+
description: string;
|
|
1343
|
+
/**
|
|
1344
|
+
* Indicating if the developer will allow the user to permanently bypass the PreProcessing
|
|
1345
|
+
* Dialog for this add-in. "false" is the default value if not specified.
|
|
1346
|
+
*/
|
|
1347
|
+
spamNeverShowAgainOption?: boolean;
|
|
1348
|
+
/**
|
|
1349
|
+
* Specifies up to five options that a user can select from the preprocessing dialog to
|
|
1350
|
+
* provide a reason for reporting a message.
|
|
1351
|
+
*/
|
|
1352
|
+
spamReportingOptions?: SpamReportingOptions;
|
|
1353
|
+
/**
|
|
1354
|
+
* A text box to the preprocessing dialog to allow users to provide additional information
|
|
1355
|
+
* on the message they're reporting. This value is the title of that text box.
|
|
1356
|
+
*/
|
|
1357
|
+
spamFreeTextSectionTitle?: string;
|
|
1358
|
+
/**
|
|
1359
|
+
* Specifies the custom text and URL to provide informational resources to the users.
|
|
1360
|
+
*/
|
|
1361
|
+
spamMoreInfo?: SpamMoreInfo;
|
|
1362
|
+
}
|
|
1363
|
+
/**
|
|
1364
|
+
* Specifies the custom text and URL to provide informational resources to the users.
|
|
1365
|
+
*/
|
|
1366
|
+
export interface SpamMoreInfo {
|
|
1367
|
+
/**
|
|
1368
|
+
* Specifies display content of the hyperlink pointing to the site containing informational
|
|
1369
|
+
* resources in the preprocessing dialog of a spam-reporting add-in.
|
|
1370
|
+
*/
|
|
1371
|
+
text: string;
|
|
1372
|
+
/**
|
|
1373
|
+
* Specifies the URL of the hyperlink pointing to the site containing informational
|
|
1374
|
+
* resources in the preprocessing dialog of a spam-reporting add-in.
|
|
1375
|
+
*/
|
|
1376
|
+
url: string;
|
|
1377
|
+
[property: string]: any;
|
|
1378
|
+
}
|
|
1379
|
+
/**
|
|
1380
|
+
* Specifies up to five options that a user can select from the preprocessing dialog to
|
|
1381
|
+
* provide a reason for reporting a message.
|
|
1382
|
+
*/
|
|
1383
|
+
export interface SpamReportingOptions {
|
|
1384
|
+
/**
|
|
1385
|
+
* Specifies the title listed before the reporting options list.
|
|
1386
|
+
*/
|
|
1387
|
+
title: string;
|
|
1388
|
+
/**
|
|
1389
|
+
* Specifies the custom options that a user can select from the preprocessing dialog to
|
|
1390
|
+
* provide a reason for reporting a message.
|
|
1391
|
+
*/
|
|
1392
|
+
options: string[];
|
|
1393
|
+
/**
|
|
1394
|
+
* Can be set to "radio" or "checkbox". This determines if Radio Buttons or checkboxes are
|
|
1395
|
+
* used for the options. "checkbox" is the default if this value is not specified.
|
|
1396
|
+
*/
|
|
1397
|
+
type?: SpamReportingOptionsType;
|
|
1398
|
+
[property: string]: any;
|
|
1399
|
+
}
|
|
1400
|
+
/**
|
|
1401
|
+
* Can be set to "radio" or "checkbox". This determines if Radio Buttons or checkboxes are
|
|
1402
|
+
* used for the options. "checkbox" is the default if this value is not specified.
|
|
1403
|
+
*/
|
|
1404
|
+
export type SpamReportingOptionsType = "radio" | "checkbox";
|
|
1405
|
+
export interface ExtensionRibbonsArrayTabsItem {
|
|
1406
|
+
/**
|
|
1407
|
+
* A unique identifier for this tab within the app. Maximum length is 64 characters.
|
|
1408
|
+
*/
|
|
1409
|
+
id?: string;
|
|
1410
|
+
/**
|
|
1411
|
+
* Displayed text for the tab. Maximum length is 64 characters.
|
|
1412
|
+
*/
|
|
1413
|
+
label?: string;
|
|
1414
|
+
position?: Position;
|
|
1415
|
+
/**
|
|
1416
|
+
* Id of the existing office Tab. Maximum length is 64 characters.
|
|
1417
|
+
*/
|
|
1418
|
+
builtInTabId?: string;
|
|
1419
|
+
/**
|
|
1420
|
+
* Defines tab groups.
|
|
1421
|
+
*/
|
|
1422
|
+
groups?: ExtensionRibbonsCustomTabGroupsItem[];
|
|
1423
|
+
/**
|
|
1424
|
+
* Defines mobile group item.
|
|
1425
|
+
*/
|
|
1426
|
+
customMobileRibbonGroups?: ExtensionRibbonsCustomMobileGroupItem[];
|
|
1427
|
+
}
|
|
1428
|
+
export interface ExtensionRibbonsCustomMobileGroupItem {
|
|
1429
|
+
/**
|
|
1430
|
+
* Specify the Id of the group. Used for mobileMessageRead ext point.
|
|
1431
|
+
*/
|
|
1432
|
+
id: string;
|
|
1433
|
+
/**
|
|
1434
|
+
* Short label of the control. Maximum length is 32 characters.
|
|
1435
|
+
*/
|
|
1436
|
+
label: string;
|
|
1437
|
+
controls: ExtensionRibbonsCustomMobileControlButtonItem[];
|
|
1438
|
+
[property: string]: any;
|
|
1439
|
+
}
|
|
1440
|
+
export interface ExtensionRibbonsCustomMobileControlButtonItem {
|
|
1441
|
+
/**
|
|
1442
|
+
* Specify the Id of the button like msgReadFunctionButton.
|
|
1443
|
+
*/
|
|
1444
|
+
id: string;
|
|
1445
|
+
type: "mobileButton";
|
|
1446
|
+
/**
|
|
1447
|
+
* Short label of the control. Maximum length is 32 characters.
|
|
1448
|
+
*/
|
|
1449
|
+
label: string;
|
|
1450
|
+
icons: ExtensionCustomMobileIcon[];
|
|
1451
|
+
/**
|
|
1452
|
+
* The ID of an action defined in runtimes. Maximum length is 64 characters.
|
|
1453
|
+
*/
|
|
1454
|
+
actionId: string;
|
|
1455
|
+
[property: string]: any;
|
|
1456
|
+
}
|
|
1457
|
+
export interface ExtensionCustomMobileIcon {
|
|
1458
|
+
/**
|
|
1459
|
+
* Size in pixels of the icon. Three image sizes are required (25, 32, and 48 pixels).
|
|
1460
|
+
*/
|
|
1461
|
+
size: number;
|
|
1462
|
+
/**
|
|
1463
|
+
* Url to the icon.
|
|
1464
|
+
*/
|
|
1465
|
+
url: string;
|
|
1466
|
+
/**
|
|
1467
|
+
* How to scale - 1,2,3 for each image. This attribute specifies the UIScreen.scale property
|
|
1468
|
+
* for iOS devices.
|
|
1469
|
+
*/
|
|
1470
|
+
scale: number;
|
|
1471
|
+
}
|
|
1472
|
+
export interface ExtensionRibbonsCustomTabGroupsItem {
|
|
1473
|
+
/**
|
|
1474
|
+
* A unique identifier for this group within the app. Maximum length is 64 characters.
|
|
1475
|
+
*/
|
|
1476
|
+
id?: string;
|
|
1477
|
+
/**
|
|
1478
|
+
* Displayed text for the group. Maximum length is 64 characters.
|
|
1479
|
+
*/
|
|
1480
|
+
label?: string;
|
|
1481
|
+
icons?: ExtensionCommonIcon[];
|
|
1482
|
+
controls?: ExtensionCommonCustomGroupControlsItem[];
|
|
1483
|
+
/**
|
|
1484
|
+
* Id of a built-in Group. Maximum length is 64 characters.
|
|
1485
|
+
*/
|
|
1486
|
+
builtInGroupId?: string;
|
|
1487
|
+
/**
|
|
1488
|
+
* Specifies whether a group will be hidden on application and platform combinations that
|
|
1489
|
+
* support the API (Office.ribbon.requestCreateControls) that installs custom contextual
|
|
1490
|
+
* tabs on the ribbon. Default is false.
|
|
1491
|
+
*/
|
|
1492
|
+
overriddenByRibbonApi?: boolean;
|
|
1493
|
+
}
|
|
1494
|
+
export interface Position {
|
|
1495
|
+
/**
|
|
1496
|
+
* The id of the built-in tab. Maximum length is 64 characters.
|
|
1497
|
+
*/
|
|
1498
|
+
builtInTabId: string;
|
|
1499
|
+
/**
|
|
1500
|
+
* Define alignment of this custom tab relative to the specified built-in tab.
|
|
1501
|
+
*/
|
|
1502
|
+
align: Align;
|
|
1503
|
+
}
|
|
1504
|
+
/**
|
|
1505
|
+
* Define alignment of this custom tab relative to the specified built-in tab.
|
|
1506
|
+
*/
|
|
1507
|
+
export type Align = "after" | "before";
|
|
1508
|
+
/**
|
|
1509
|
+
* A runtime environment for a page or script
|
|
1510
|
+
*/
|
|
1511
|
+
export interface ExtensionRuntimesArray {
|
|
1512
|
+
requirements?: RequirementsExtensionElement;
|
|
1513
|
+
/**
|
|
1514
|
+
* A unique identifier for this runtime within the app. Maximum length is 64 characters.
|
|
1515
|
+
*/
|
|
1516
|
+
id: string;
|
|
1517
|
+
/**
|
|
1518
|
+
* Supports running functions and launching pages.
|
|
1519
|
+
*/
|
|
1520
|
+
type?: "general";
|
|
1521
|
+
code: ExtensionRuntimeCode;
|
|
1522
|
+
/**
|
|
1523
|
+
* Runtimes with a short lifetime do not preserve state across executions. Runtimes with a
|
|
1524
|
+
* long lifetime do.
|
|
1525
|
+
*/
|
|
1526
|
+
lifetime?: Lifetime;
|
|
1527
|
+
actions?: ExtensionRuntimesActionsItem[];
|
|
1528
|
+
customFunctions?: ExtensionCustomFunctions;
|
|
1529
|
+
}
|
|
1530
|
+
/**
|
|
1531
|
+
* Specifies the set of actions supported by this runtime. An action is either running a
|
|
1532
|
+
* JavaScript function or opening a view such as a task pane.
|
|
1533
|
+
*/
|
|
1534
|
+
export interface ExtensionRuntimesActionsItem {
|
|
1535
|
+
/**
|
|
1536
|
+
* Identifier for this action. Maximum length is 64 characters. This value is passed to the
|
|
1537
|
+
* code file.
|
|
1538
|
+
*/
|
|
1539
|
+
id: string;
|
|
1540
|
+
/**
|
|
1541
|
+
* executeFunction: Run a script function without waiting for it to finish. openPate: Open a
|
|
1542
|
+
* page in a view.
|
|
1543
|
+
*/
|
|
1544
|
+
type: ActionType;
|
|
1545
|
+
/**
|
|
1546
|
+
* Display name of the action. Maximum length is 64 characters.
|
|
1547
|
+
*/
|
|
1548
|
+
displayName?: string;
|
|
1549
|
+
/**
|
|
1550
|
+
* Specifies that a task pane supports pinning, which keeps the task pane open when the user
|
|
1551
|
+
* changes the selection.
|
|
1552
|
+
*/
|
|
1553
|
+
pinnable?: boolean;
|
|
1554
|
+
/**
|
|
1555
|
+
* View where the page should be opened. Maximum length is 64 characters.
|
|
1556
|
+
*/
|
|
1557
|
+
view?: string;
|
|
1558
|
+
/**
|
|
1559
|
+
* Whether allows the action to have multiple selection.
|
|
1560
|
+
*/
|
|
1561
|
+
multiselect?: boolean;
|
|
1562
|
+
/**
|
|
1563
|
+
* Whether allows task pane add-ins to activate without the Reading Pane enabled or a
|
|
1564
|
+
* message selected.
|
|
1565
|
+
*/
|
|
1566
|
+
supportsNoItemContext?: boolean;
|
|
1567
|
+
}
|
|
1568
|
+
/**
|
|
1569
|
+
* executeFunction: Run a script function without waiting for it to finish. openPate: Open a
|
|
1570
|
+
* page in a view.
|
|
1571
|
+
*/
|
|
1572
|
+
export type ActionType = "executeFunction" | "openPage";
|
|
1573
|
+
/**
|
|
1574
|
+
* Custom function enable developers to add new functions to Excel by defining those
|
|
1575
|
+
* functions in JavaScript as part of an add-in. Users within Excel can access custom
|
|
1576
|
+
* functions just as they would any native function in Excel, such as SUM().
|
|
1577
|
+
*/
|
|
1578
|
+
export interface ExtensionCustomFunctions {
|
|
1579
|
+
/**
|
|
1580
|
+
* Array of function object which defines function metadata.
|
|
1581
|
+
*/
|
|
1582
|
+
functions: ExtensionFunction[];
|
|
1583
|
+
namespace: ExtensionCustomFunctionsNamespace;
|
|
1584
|
+
/**
|
|
1585
|
+
* Allows a custom function to accept Excel data types as parameters and return values.
|
|
1586
|
+
*/
|
|
1587
|
+
allowCustomDataForDataTypeAny?: boolean;
|
|
1588
|
+
[property: string]: any;
|
|
1589
|
+
}
|
|
1590
|
+
export interface ExtensionFunction {
|
|
1591
|
+
/**
|
|
1592
|
+
* A unique ID for the function.
|
|
1593
|
+
*/
|
|
1594
|
+
id: string;
|
|
1595
|
+
/**
|
|
1596
|
+
* The name of the function that end users see in Excel. In Excel, this function name is
|
|
1597
|
+
* prefixed by the custom functions namespace that's specified in the manifest file.
|
|
1598
|
+
*/
|
|
1599
|
+
name: string;
|
|
1600
|
+
/**
|
|
1601
|
+
* The description of the function that end users see in Excel.
|
|
1602
|
+
*/
|
|
1603
|
+
description?: string;
|
|
1604
|
+
/**
|
|
1605
|
+
* URL that provides information about the function. (It is displayed in a task pane.)
|
|
1606
|
+
*/
|
|
1607
|
+
helpUrl?: string;
|
|
1608
|
+
/**
|
|
1609
|
+
* Array that defines the input parameters for the function.
|
|
1610
|
+
*/
|
|
1611
|
+
parameters: ExtensionFunctionParameter[];
|
|
1612
|
+
result: ExtensionResult;
|
|
1613
|
+
/**
|
|
1614
|
+
* If true, the function can output repeatedly to the cell even when invoked only once. This
|
|
1615
|
+
* option is useful for rapidly-changing data sources, such as a stock price. The function
|
|
1616
|
+
* should have no return statement. Instead, the result value is passed as the argument of
|
|
1617
|
+
* the StreamingInvocation.setResult callback function.
|
|
1618
|
+
*/
|
|
1619
|
+
stream?: boolean;
|
|
1620
|
+
/**
|
|
1621
|
+
* If true, the function recalculates each time Excel recalculates, instead of only when the
|
|
1622
|
+
* formula's dependent values have changed. A function can't use both the stream and
|
|
1623
|
+
* volatile properties. If the stream and volatile properties are both set to true, the
|
|
1624
|
+
* volatile property will be ignored.
|
|
1625
|
+
*/
|
|
1626
|
+
volatile?: boolean;
|
|
1627
|
+
/**
|
|
1628
|
+
* If true, Excel calls the CancelableInvocation handler whenever the user takes an action
|
|
1629
|
+
* that has the effect of canceling the function; for example, manually triggering
|
|
1630
|
+
* recalculation or editing a cell that is referenced by the function. Cancelable functions
|
|
1631
|
+
* are typically only used for asynchronous functions that return a single result and need
|
|
1632
|
+
* to handle the cancellation of a request for data. A function can't use both the stream
|
|
1633
|
+
* and cancelable properties.
|
|
1634
|
+
*/
|
|
1635
|
+
cancelable?: boolean;
|
|
1636
|
+
/**
|
|
1637
|
+
* If true, your custom function can access the address of the cell that invoked it. The
|
|
1638
|
+
* address property of the invocation parameter contains the address of the cell that
|
|
1639
|
+
* invoked your custom function. A function can't use both the stream and requiresAddress
|
|
1640
|
+
* properties.
|
|
1641
|
+
*/
|
|
1642
|
+
requiresAddress?: boolean;
|
|
1643
|
+
/**
|
|
1644
|
+
* If true, your custom function can access the addresses of the function's input
|
|
1645
|
+
* parameters. This property must be used in combination with the dimensionality property of
|
|
1646
|
+
* the result object, and dimensionality must be set to matrix.
|
|
1647
|
+
*/
|
|
1648
|
+
requiresParameterAddress?: boolean;
|
|
1649
|
+
[property: string]: any;
|
|
1650
|
+
}
|
|
1651
|
+
export interface ExtensionFunctionParameter {
|
|
1652
|
+
/**
|
|
1653
|
+
* The name of the parameter. This name is displayed in Excel's IntelliSense.
|
|
1654
|
+
*/
|
|
1655
|
+
name: string;
|
|
1656
|
+
/**
|
|
1657
|
+
* A description of the parameter. This is displayed in Excel's IntelliSense.
|
|
1658
|
+
*/
|
|
1659
|
+
description?: string;
|
|
1660
|
+
/**
|
|
1661
|
+
* The data type of the parameter. It can only be 'boolean', 'number', 'string', 'any',
|
|
1662
|
+
* 'CustomFunctions.Invocation', 'CustomFunctions.StreamingInvocation' or
|
|
1663
|
+
* 'CustomFunctions.CancelableInvocation', 'any' allows you to use any of other types.
|
|
1664
|
+
*/
|
|
1665
|
+
type?: string;
|
|
1666
|
+
/**
|
|
1667
|
+
* A subfield of the type property. Specifies the Excel data types accepted by the custom
|
|
1668
|
+
* function. Accepts the values 'cellvalue', 'booleancellvalue', 'doublecellvalue',
|
|
1669
|
+
* 'entitycellvalue', 'errorcellvalue', 'formattednumbercellvalue', 'linkedentitycellvalue',
|
|
1670
|
+
* 'localimagecellvalue', 'stringcellvalue', 'webimagecellvalue'
|
|
1671
|
+
*/
|
|
1672
|
+
cellValueType?: CellValueType;
|
|
1673
|
+
/**
|
|
1674
|
+
* Must be either scalar (a non-array value) or matrix (a 2-dimensional array).
|
|
1675
|
+
*/
|
|
1676
|
+
dimensionality?: Dimensionality;
|
|
1677
|
+
/**
|
|
1678
|
+
* If true, the parameter is optional.
|
|
1679
|
+
*/
|
|
1680
|
+
optional?: boolean | null;
|
|
1681
|
+
/**
|
|
1682
|
+
* If true, parameters populate from a specified array. Note that functions all repeating
|
|
1683
|
+
* parameters are considered optional parameters by definition.
|
|
1684
|
+
*/
|
|
1685
|
+
repeating?: boolean;
|
|
1686
|
+
[property: string]: any;
|
|
1687
|
+
}
|
|
1688
|
+
/**
|
|
1689
|
+
* A subfield of the type property. Specifies the Excel data types accepted by the custom
|
|
1690
|
+
* function. Accepts the values 'cellvalue', 'booleancellvalue', 'doublecellvalue',
|
|
1691
|
+
* 'entitycellvalue', 'errorcellvalue', 'formattednumbercellvalue', 'linkedentitycellvalue',
|
|
1692
|
+
* 'localimagecellvalue', 'stringcellvalue', 'webimagecellvalue'
|
|
1693
|
+
*/
|
|
1694
|
+
export type CellValueType = "cellvalue" | "booleancellvalue" | "doublecellvalue" | "entitycellvalue" | "errorcellvalue" | "formattednumbercellvalue" | "linkedentitycellvalue" | "localimagecellvalue" | "stringcellvalue" | "webimagecellvalue";
|
|
1695
|
+
/**
|
|
1696
|
+
* Must be either scalar (a non-array value) or matrix (a 2-dimensional array).
|
|
1697
|
+
*
|
|
1698
|
+
* Must be either scalar (a non-array value) or matrix (a 2-dimensional array). Default:
|
|
1699
|
+
* scalar.
|
|
1700
|
+
*/
|
|
1701
|
+
export type Dimensionality = "scalar" | "matrix";
|
|
1702
|
+
/**
|
|
1703
|
+
* Object that defines the type of information that is returned by the function.
|
|
1704
|
+
*/
|
|
1705
|
+
export interface ExtensionResult {
|
|
1706
|
+
/**
|
|
1707
|
+
* Must be either scalar (a non-array value) or matrix (a 2-dimensional array). Default:
|
|
1708
|
+
* scalar.
|
|
1709
|
+
*/
|
|
1710
|
+
dimensionality?: Dimensionality;
|
|
1711
|
+
[property: string]: any;
|
|
1712
|
+
}
|
|
1713
|
+
/**
|
|
1714
|
+
* Defines the namespace for your custom functions. A namespace prepends itself to your
|
|
1715
|
+
* custom functions to help customers identify your functions as part of your add-in.
|
|
1716
|
+
*/
|
|
1717
|
+
export interface ExtensionCustomFunctionsNamespace {
|
|
1718
|
+
/**
|
|
1719
|
+
* Non-localizable version of the namespace.
|
|
1720
|
+
*/
|
|
1721
|
+
id: string;
|
|
1722
|
+
/**
|
|
1723
|
+
* Localizable version of the namespace.
|
|
1724
|
+
*/
|
|
1725
|
+
name: string;
|
|
1726
|
+
[property: string]: any;
|
|
1727
|
+
}
|
|
1728
|
+
/**
|
|
1729
|
+
* Runtimes with a short lifetime do not preserve state across executions. Runtimes with a
|
|
1730
|
+
* long lifetime do.
|
|
1731
|
+
*/
|
|
1732
|
+
export type Lifetime = "short" | "long";
|
|
1733
|
+
/**
|
|
1734
|
+
* Supports running functions and launching pages.
|
|
1735
|
+
*/
|
|
1736
|
+
/**
|
|
1737
|
+
* Specify the app's Graph connector configuration. If this is present then
|
|
1738
|
+
* webApplicationInfo.id must also be specified.
|
|
1739
|
+
*/
|
|
1740
|
+
export interface GraphConnector {
|
|
1741
|
+
/**
|
|
1742
|
+
* The url where Graph-connector notifications for the application should be sent.
|
|
1743
|
+
*/
|
|
1744
|
+
notificationUrl: string;
|
|
1745
|
+
}
|
|
1746
|
+
export interface Icons {
|
|
1747
|
+
/**
|
|
1748
|
+
* A relative file path to a transparent PNG outline icon. The border color needs to be
|
|
1749
|
+
* white. Size 32x32.
|
|
1750
|
+
*/
|
|
1751
|
+
outline: string;
|
|
1752
|
+
/**
|
|
1753
|
+
* A relative file path to a full color PNG icon. Size 192x192.
|
|
1754
|
+
*/
|
|
1755
|
+
color: string;
|
|
1756
|
+
/**
|
|
1757
|
+
* A relative file path to a full color PNG icon with transparent background. Size 32x32.
|
|
1758
|
+
*/
|
|
1759
|
+
color32x32?: string;
|
|
1760
|
+
}
|
|
1761
|
+
/**
|
|
1762
|
+
* The Intune-related properties for the app.
|
|
1763
|
+
*/
|
|
1764
|
+
export interface IntuneInfo {
|
|
1765
|
+
/**
|
|
1766
|
+
* Supported mobile app managment version that the app is compliant with.
|
|
1767
|
+
*/
|
|
1768
|
+
supportedMobileAppManagementVersion?: string;
|
|
1769
|
+
}
|
|
1770
|
+
export interface LocalizationInfo {
|
|
1771
|
+
/**
|
|
1772
|
+
* The language tag of the strings in this top level manifest file.
|
|
1773
|
+
*/
|
|
1774
|
+
defaultLanguageTag: string;
|
|
1775
|
+
/**
|
|
1776
|
+
* A relative file path to a the .json file containing strings in the default language.
|
|
1777
|
+
*/
|
|
1778
|
+
defaultLanguageFile?: string;
|
|
1779
|
+
additionalLanguages?: AdditionalLanguage[];
|
|
1780
|
+
}
|
|
1781
|
+
export interface AdditionalLanguage {
|
|
1782
|
+
/**
|
|
1783
|
+
* The language tag of the strings in the provided file.
|
|
1784
|
+
*/
|
|
1785
|
+
languageTag: string;
|
|
1786
|
+
/**
|
|
1787
|
+
* A relative file path to a the .json file containing the translated strings.
|
|
1788
|
+
*/
|
|
1789
|
+
file: string;
|
|
1790
|
+
}
|
|
1791
|
+
/**
|
|
1792
|
+
* Specify meeting extension definition.
|
|
1793
|
+
*/
|
|
1794
|
+
export interface MeetingExtensionDefinition {
|
|
1795
|
+
/**
|
|
1796
|
+
* Meeting supported scenes.
|
|
1797
|
+
*/
|
|
1798
|
+
scenes?: Scene[];
|
|
1799
|
+
/**
|
|
1800
|
+
* Represents if the app has added support for sharing to stage.
|
|
1801
|
+
*/
|
|
1802
|
+
supportsCustomShareToStage?: boolean;
|
|
1803
|
+
/**
|
|
1804
|
+
* A boolean value indicating whether this app can stream the meeting's audio video content
|
|
1805
|
+
* to an RTMP endpoint.
|
|
1806
|
+
*/
|
|
1807
|
+
supportsStreaming?: boolean;
|
|
1808
|
+
/**
|
|
1809
|
+
* A boolean value indicating whether this app allows management by anonymous users.
|
|
1810
|
+
*/
|
|
1811
|
+
supportsAnonymousGuestUsers?: boolean;
|
|
1812
|
+
}
|
|
1813
|
+
export interface Scene {
|
|
1814
|
+
/**
|
|
1815
|
+
* A unique identifier for this scene. This id must be a GUID.
|
|
1816
|
+
*/
|
|
1817
|
+
id: string;
|
|
1818
|
+
/**
|
|
1819
|
+
* Scene name.
|
|
1820
|
+
*/
|
|
1821
|
+
name: string;
|
|
1822
|
+
/**
|
|
1823
|
+
* A relative file path to a scene metadata json file.
|
|
1824
|
+
*/
|
|
1825
|
+
file: string;
|
|
1826
|
+
/**
|
|
1827
|
+
* A relative file path to a scene PNG preview icon.
|
|
1828
|
+
*/
|
|
1829
|
+
preview: string;
|
|
1830
|
+
/**
|
|
1831
|
+
* Maximum audiences supported in scene.
|
|
1832
|
+
*/
|
|
1833
|
+
maxAudience: number;
|
|
1834
|
+
/**
|
|
1835
|
+
* Number of seats reserved for organizers or presenters.
|
|
1836
|
+
*/
|
|
1837
|
+
seatsReservedForOrganizersOrPresenters: number;
|
|
1838
|
+
}
|
|
1839
|
+
export interface NameClass {
|
|
1840
|
+
/**
|
|
1841
|
+
* A short display name for the app.
|
|
1842
|
+
*/
|
|
1843
|
+
short: string;
|
|
1844
|
+
/**
|
|
1845
|
+
* The full name of the app, used if the full app name exceeds 30 characters.
|
|
1846
|
+
*/
|
|
1847
|
+
full?: string;
|
|
1848
|
+
}
|
|
1849
|
+
export type Permission = "identity" | "messageTeamMembers";
|
|
1850
|
+
export interface StaticTab {
|
|
1851
|
+
/**
|
|
1852
|
+
* A unique identifier for the entity which the tab displays.
|
|
1853
|
+
*/
|
|
1854
|
+
entityId: string;
|
|
1855
|
+
/**
|
|
1856
|
+
* The display name of the tab.
|
|
1857
|
+
*/
|
|
1858
|
+
name?: string;
|
|
1859
|
+
/**
|
|
1860
|
+
* The url which points to the entity UI to be displayed in the canvas.
|
|
1861
|
+
*/
|
|
1862
|
+
contentUrl?: string;
|
|
1863
|
+
/**
|
|
1864
|
+
* The Microsoft App ID specified for the bot in the Bot Framework portal
|
|
1865
|
+
* (https://dev.botframework.com/bots)
|
|
1866
|
+
*/
|
|
1867
|
+
contentBotId?: string;
|
|
1868
|
+
/**
|
|
1869
|
+
* The url to point at if a user opts to view in a browser.
|
|
1870
|
+
*/
|
|
1871
|
+
websiteUrl?: string;
|
|
1872
|
+
/**
|
|
1873
|
+
* The url to direct a user's search queries.
|
|
1874
|
+
*/
|
|
1875
|
+
searchUrl?: string;
|
|
1876
|
+
/**
|
|
1877
|
+
* Specifies whether the tab offers an experience in the context of a channel in a team, or
|
|
1878
|
+
* an experience scoped to an individual user alone or group chat. These options are
|
|
1879
|
+
* non-exclusive. Currently static tabs are only supported in the 'personal' scope.
|
|
1880
|
+
*/
|
|
1881
|
+
scopes: StaticTabScope[];
|
|
1882
|
+
/**
|
|
1883
|
+
* The set of contextItem scopes that a tab belong to
|
|
1884
|
+
*/
|
|
1885
|
+
context?: StaticTabContext[];
|
|
1886
|
+
requirementSet?: ElementRequirementSet;
|
|
1887
|
+
}
|
|
1888
|
+
export type StaticTabContext = "personalTab" | "channelTab" | "privateChatTab" | "meetingChatTab" | "meetingDetailsTab" | "meetingSidePanel" | "meetingStage" | "teamLevelApp";
|
|
1889
|
+
export type StaticTabScope = "team" | "personal" | "groupChat";
|
|
1890
|
+
/**
|
|
1891
|
+
* Subscription offer associated with this app.
|
|
1892
|
+
*/
|
|
1893
|
+
export interface SubscriptionOffer {
|
|
1894
|
+
/**
|
|
1895
|
+
* A unique identifier for the Commercial Marketplace Software as a Service Offer.
|
|
1896
|
+
*/
|
|
1897
|
+
offerId: string;
|
|
1898
|
+
}
|
|
1899
|
+
export type SupportedChannelType = "sharedChannels" | "privateChannels";
|
|
1900
|
+
/**
|
|
1901
|
+
* Specify your AAD App ID and Graph information to help users seamlessly sign into your AAD
|
|
1902
|
+
* app.
|
|
1903
|
+
*/
|
|
1904
|
+
export interface WebApplicationInfo {
|
|
1905
|
+
/**
|
|
1906
|
+
* AAD application id of the app. This id must be a GUID.
|
|
1907
|
+
*/
|
|
1908
|
+
id: string;
|
|
1909
|
+
/**
|
|
1910
|
+
* Resource url of app for acquiring auth token for SSO.
|
|
1911
|
+
*/
|
|
1912
|
+
resource?: string;
|
|
1913
|
+
/**
|
|
1914
|
+
* By including this property, an NAA token based on its contents will be prefetched when
|
|
1915
|
+
* the tab is loaded.
|
|
1916
|
+
*/
|
|
1917
|
+
nestedAppAuthInfo?: NestedAppAuthInfo[];
|
|
1918
|
+
}
|
|
1919
|
+
export interface NestedAppAuthInfo {
|
|
1920
|
+
/**
|
|
1921
|
+
* Represents the nested app's valid redirect URI (always a base origin).
|
|
1922
|
+
*/
|
|
1923
|
+
redirectUri: string;
|
|
1924
|
+
/**
|
|
1925
|
+
* Represents the stringified list of scopes the access token requested requires. Order must
|
|
1926
|
+
* match that of the proceeding NAA request in the app.
|
|
1927
|
+
*/
|
|
1928
|
+
scopes: string[];
|
|
1929
|
+
/**
|
|
1930
|
+
* An optional JSON formatted object of client capabilities that represents if the resource
|
|
1931
|
+
* server is CAE capable. Do not use an empty string for this value. If unsupported, keep
|
|
1932
|
+
* the field undefined. If supported, use the following string exactly:
|
|
1933
|
+
* '{"access_token":{"xms_cc":{"values":["CP1"]}}}'. More info on client capabilities here:
|
|
1934
|
+
* https://learn.microsoft.com/en-us/entra/identity-platform/claims-challenge?tabs=dotnet#how-to-communicate-client-capabilities-to-microsoft-entra-id
|
|
1935
|
+
*/
|
|
1936
|
+
claims?: string;
|
|
1937
|
+
}
|
|
1938
|
+
export declare class Convert {
|
|
1939
|
+
static toTeamsManifestV1D23(json: string): TeamsManifestV1D23;
|
|
1940
|
+
static teamsManifestV1D23ToJson(value: TeamsManifestV1D23): string;
|
|
1941
|
+
}
|