-
Notifications
You must be signed in to change notification settings - Fork 16
/
iadaptivecardextensionmanifestentry.yml
237 lines (200 loc) · 10.3 KB
/
iadaptivecardextensionmanifestentry.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
### YamlMime:TSType
name: IAdaptiveCardExtensionManifestEntry
uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry:interface'
package: '@microsoft/sp-module-interfaces!'
fullName: IAdaptiveCardExtensionManifestEntry
summary: >-
This interface specifies the set of properties that can be pre-configured by a AdaptiveCardExtension developer. Each
pre-configured instance of the AdaptiveCardExtension will need a copy of these properties. Organization admins and
content authors can modify these properties on a need basis.
remarks: ''
isPreview: true
isDeprecated: false
type: interface
properties:
- name: cardSize
uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#cardSize:member'
package: '@microsoft/sp-module-interfaces!'
fullName: cardSize
summary: >-
Size of the AdaptiveCardExtension when it is rendered. This is value must be one of the supported CardSizes
\["Medium", "Large"\] defined in the sp-adaptive-card-base project.
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: 'cardSize: string;'
return:
type: string
- name: dataVersion
uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#dataVersion:member'
package: '@microsoft/sp-module-interfaces!'
fullName: dataVersion
summary: >-
Definition: Use this field to specify the data version of the pre-configured data provided to the
AdaptiveCardExtension. Note that data version is different from the version field in the manifest.
remarks: >-
The manifest version is used to control the versioning of the AdaptiveCardExtension code, while data version is
used to control the versioning of the serialized data of the AdaptiveCardExtension. Refer to dataVersion field of
your AdaptiveCardExtension for more information.
Usage: versioning and evolving the serialized data of the AdaptiveCardExtension
Type: string representing a [semantic version](http://semver.org) with only two parts
Supported values: MAJOR.MINOR
Example: `"1.0"`
isPreview: true
isDeprecated: false
syntax:
content: 'dataVersion?: string;'
return:
type: string
- name: description
uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#description:member'
package: '@microsoft/sp-module-interfaces!'
fullName: description
summary: >-
Description of the AdaptiveCardExtension represented as a dictionary of locale keys to description values. This
value will be displayed to the user in the toolbox. This description should be used in the Toolbox tooltip and
other display areas.
remarks: >-
The AdaptiveCardExtension developer may give an initial description to the AdaptiveCardExtension. The organization
admin and page author will have the ability to change this description as per need.
Usage: display the description of the AdaptiveCardExtension in the toolbox tooltip, web part gallery and the page.
Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key.
Example: `"A tool for displaying neat information."`
```
{
"default": "A tool for displaying neat information.",
"en-us": "A tool for displaying neat information.",
"fr-fr": "Un outil d'affichage des informations soignées.",
"zh": "用於顯示整潔資訊的工具。"
}
```
isPreview: true
isDeprecated: false
syntax:
content: 'description: ILocalizedString;'
return:
type: '<xref uid="@microsoft/sp-module-interfaces!ILocalizedString:interface" />'
- name: groupId
uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#groupId:member'
package: '@microsoft/sp-module-interfaces!'
fullName: groupId
summary: >-
The group id to determine which modern group contains the AdaptiveCardExtension in modern site page. The
SharePoint Framework reserves group ids for predefined groups. The developer can pick one from those groups. If
the developer fills an id not in the predefined groups, it falls back to Other group.
remarks: |-
Supported values: the GUID from PredefinedGroup list
Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"`
isPreview: true
isDeprecated: false
syntax:
content: 'groupId: PredefinedGroup | string;'
return:
type: '<xref uid="@microsoft/sp-module-interfaces!PredefinedGroup:enum" /> | string'
- name: iconImageUrl
uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#iconImageUrl:member'
package: '@microsoft/sp-module-interfaces!'
fullName: iconImageUrl
summary: >-
The icon for the AdaptiveCardExtension, to be displayed in the toolbox, represented an image URL. The image at the
URL must be exactly 40x28 px (SPPPLAT VSO\#218660 to fix the size of the icon image).
remarks: >-
If the
[IClientSideWebPartManifestEntry.officeFabricIconFontName](xref:@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry%23officeFabricIconFontName:member)
field does not have a value, this field must have a value. This value can be an absolute URL (e.g.
`"http://example.com/icons/my-icon.png"`<!-- -->) or a relative file path (e.g. `"./icons/my-icon.png"`<!-- -->).
In the latter case, the path will be resolved relative to the folder containing the input manifest. The icon file
will be copied to the deployment folder like an asset, and the output manifest's iconImageUrl will be replaced
with a URL relative to the URL used to load all other assets (the loaderConfig.internalModuleBaseUrls property).
Supported values: Any absolute URL.
Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"`
isPreview: true
isDeprecated: false
syntax:
content: 'iconImageUrl?: string;'
return:
type: string
- name: officeFabricIconFontName
uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#officeFabricIconFontName:member'
package: '@microsoft/sp-module-interfaces!'
fullName: officeFabricIconFontName
summary: >-
The icon for the AdaptiveCardExtension, to be displayed in the toolbox, represented as a character name in the
Office 365 icon font file.
remarks: >-
The icon font is specified here: [https://aka.ms/uifabric-icons](https://aka.ms/uifabric-icons) If this field has
a value, the
[IClientSideWebPartManifestEntry.iconImageUrl](xref:@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry%23iconImageUrl:member)
field will be ignored.
Supported values: Any character name in the Office 365 Icon Font.
Example: "graph"
isPreview: true
isDeprecated: false
syntax:
content: 'officeFabricIconFontName?: string;'
return:
type: string
- name: properties
uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#properties:member'
package: '@microsoft/sp-module-interfaces!'
fullName: properties
summary: >-
Every AdaptiveCardExtension is expected to have some custom properties. For example, a page AdaptiveCardExtension
might define properties for the page URL and caption text. A list AdaptiveCardExtension may have the list ID and
list title as its properties, and so on.
remarks: >-
The SharePoint Framework passes these properties to the AdaptiveCardExtensions when they are loaded. The
AdaptiveCardExtension developer fully controls the schema for these properties. The AdaptiveCardExtension
developer should follow versioning rules when updating the properties.
Usage: rendering of the AdaptiveCardExtension
Example: `{"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"`
isPreview: true
isDeprecated: false
syntax:
content: 'properties: TProperties;'
return:
type: TProperties
- name: tags
uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#tags:member'
package: '@microsoft/sp-module-interfaces!'
fullName: tags
summary: >-
This field is used to tag a AdaptiveCardExtension with keywords that are different from the AdaptiveCardExtension
group name. Tags can be used for categorization and searching of AdaptiveCardExtensions. For example, in the
toolbox.
remarks: 'Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`'
isPreview: true
isDeprecated: false
syntax:
content: 'tags?: ILocalizedString[];'
return:
type: '<xref uid="@microsoft/sp-module-interfaces!ILocalizedString:interface" />[]'
- name: title
uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#title:member'
package: '@microsoft/sp-module-interfaces!'
fullName: title
summary: >-
Title of the AdaptiveCardExtension represented as a single a dictionary of locale keys to title values. This value
will be displayed to the user in the toolbox.
remarks: >-
This title should be used in the Toolbox and other display areas. The AdaptiveCardExtension developer may give an
initial title to the AdaptiveCardExtension. The organization admin and page author will have the ability to change
this title as per need.
Usage: display the name of the AdaptiveCardExtension in the toolbox, web part gallery and the page.
Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key.
Example: `"My Webpart"`
```
{
"default": "My WebPart"
"en-us": "My WebPart",
"fr-fr": "Ma WebPart",
"zh": "我的 web 部件"
}
```
isPreview: true
isDeprecated: false
syntax:
content: 'title: ILocalizedString;'
return:
type: '<xref uid="@microsoft/sp-module-interfaces!ILocalizedString:interface" />'