-
Notifications
You must be signed in to change notification settings - Fork 16
/
baseadaptivecardextension.yml
691 lines (684 loc) · 31.1 KB
/
baseadaptivecardextension.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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
### YamlMime:TSType
name: BaseAdaptiveCardExtension
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension:class'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: BaseAdaptiveCardExtension
summary: Base class for Adaptive Card Extensions.
remarks: Adaptive Card Extensions must inherit from this class.
isPreview: false
isDeprecated: false
type: class
constructors:
- name: (constructor)()
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension:constructor(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: (constructor)()
summary: Constructs a new instance of the `BaseAdaptiveCardExtension` class
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: constructor();
properties:
- name: _iconProperty
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#_iconProperty:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: _iconProperty
summary: ''
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'protected _iconProperty: string;'
return:
type: string
- name: _title
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#_title:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: _title
summary: ''
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'protected _title: string;'
return:
type: string
- name: cardNavigator
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#cardNavigator:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: cardNavigator
summary: 'The [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class) for the Card view.'
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'get cardNavigator(): IViewNavigator<BaseCardView<TProperties, TState>>;'
return:
type: >-
<xref uid="@microsoft/sp-adaptive-card-extension-base!IViewNavigator:interface" /><<xref
uid="@microsoft/sp-adaptive-card-extension-base!BaseCardView:class" /><TProperties, TState>>
- name: cardSize
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#cardSize:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: cardSize
summary: 'The current [CardSize](xref:@microsoft/sp-adaptive-card-extension-base!CardSize:type)<!-- -->.'
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'protected get cardSize(): CardSize;'
return:
type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!CardSize:type" />'
- name: context
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#context:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: context
summary: 'See [BaseComponent.context](xref:@microsoft/sp-component-base!BaseComponent%23context:member)<!-- -->.'
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'protected context: AdaptiveCardExtensionContext;'
return:
type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext:class" />'
- name: dataVersion
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#dataVersion:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: dataVersion
summary: >-
The value of this property is stored in the serialized data of the Adaptive Card Extension. It can be used to
manage versioning of the Adaptive Card Extension.
remarks: The default version is 1.0.
isPreview: false
isDeprecated: false
syntax:
content: 'protected get dataVersion(): Version;'
return:
type: '<xref uid="@microsoft/sp-core-library!Version:class" />'
- name: description
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#description:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: description
summary: The description of the Adaptive Card Extension defined in the manifest.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'protected get description(): string;'
return:
type: string
- name: displayMode
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#displayMode:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: displayMode
summary: 'The current [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum)<!-- -->.'
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'get displayMode(): DisplayMode;'
return:
type: '<xref uid="@microsoft/sp-core-library!DisplayMode:enum" />'
- name: iconProperty
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#iconProperty:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: iconProperty
summary: The icon url used to render an icon on the Card view.
remarks: 'By default, this will return the iconImageUrl defined in the manifest.'
isPreview: false
isDeprecated: false
syntax:
content: |-
/** @virtual */
get iconProperty(): string;
return:
type: string
- name: isRenderAsync
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#isRenderAsync:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: isRenderAsync
summary: Indicates whether the ACE is rendering in async mode.
remarks: >-
If the ACE overrides this field to return true, then it needs to call renderCompleted API after the ACE finishes
initializing.
The default value is false.
isPreview: true
isDeprecated: false
syntax:
content: 'protected get isRenderAsync(): boolean;'
return:
type: boolean
- name: isVisible
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#isVisible:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: isVisible
summary: Sets the visibility of the Adaptive Card Extension and re-render
remarks: >-
This method should be called after a card view has been registered. Otherwise visibility change will not be
applied to the Adaptive Card.
isPreview: false
isDeprecated: false
syntax:
content: |-
get isVisible(): boolean;
set isVisible(value: boolean);
return:
type: boolean
- name: navigator
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#navigator:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: navigator
summary: 'The current [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class)<!-- -->.'
remarks: >-
If the current
[BaseAdaptiveCardExtension.renderType](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23renderType:member)
is `QuickView` then returns
[BaseAdaptiveCardExtension.quickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23quickViewNavigator:member)<!--
-->.
isPreview: false
isDeprecated: false
syntax:
content: 'get navigator(): IViewNavigator<BaseView<TProperties, TState>>;'
return:
type: >-
<xref uid="@microsoft/sp-adaptive-card-extension-base!IViewNavigator:interface" /><<xref
uid="@microsoft/sp-adaptive-card-extension-base!BaseView:class" /><TProperties, TState>>
- name: properties
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#properties:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: properties
summary: 'The custom, persisted properties of the Adaptive Card Extension.'
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'protected get properties(): TProperties;'
return:
type: TProperties
- name: propertiesMetadata
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#propertiesMetadata:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: propertiesMetadata
summary: >-
This property defines metadata for the Adaptive Card Extension property bag. The metadata can help SharePoint
understand the content of the properties better and perform relevant services on the data.
remarks: >-
See
[IAdaptiveCardExtensionPropertiesMetadata](xref:@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface)
for more information about how to define metadata.
isPreview: false
isDeprecated: false
syntax:
content: |-
/** @virtual */
protected get propertiesMetadata(): IAdaptiveCardExtensionPropertiesMetadata | undefined;
return:
type: >-
<xref uid="@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertiesMetadata:interface" /> |
undefined
- name: quickViewNavigator
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#quickViewNavigator:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: quickViewNavigator
summary: >-
[QuickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class) is a
[ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class) for the Quick view.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'get quickViewNavigator(): IQuickViewNavigator<BaseQuickView<TProperties, TState>>;'
return:
type: >-
<xref uid="@microsoft/sp-adaptive-card-extension-base!IQuickViewNavigator:interface" /><<xref
uid="@microsoft/sp-adaptive-card-extension-base!BaseQuickView:class" /><TProperties, TState>>
- name: renderedFromPersistedData
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderedFromPersistedData:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: renderedFromPersistedData
summary: >-
Indicates whether the Adaptive Card Extension was rendered from persisted data or initialized from a default
state.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'protected get renderedFromPersistedData(): boolean;'
return:
type: boolean
- name: renderedOnce
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderedOnce:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: renderedOnce
summary: Indicates whether the Adaptive Card Extension has initially rendered.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'get renderedOnce(): boolean;'
return:
type: boolean
- name: renderType
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderType:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: renderType
summary: 'The current [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type)<!-- -->.'
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'get renderType(): RenderType;'
return:
type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!RenderType:type" />'
- name: state
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#state:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: state
summary: Gets the custom state of the Adaptive Card Extension.
remarks: >-
This property should not be directly updated. Please use
[BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1))
to update the state after initialization.
isPreview: false
isDeprecated: false
syntax:
content: |-
protected get state(): Readonly<TState>;
protected set state(initialState: Readonly<TState>);
return:
type: Readonly<TState>
- name: title
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#title:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: title
summary: >-
This value is displayed in Card and Quick view unless it is explicitly overridden by the Views. It is also
displayed as the Property Pane title.
remarks: 'By default, this will return the title defined in the manifest.'
isPreview: false
isDeprecated: false
syntax:
content: |-
/** @virtual */
get title(): string;
return:
type: string
methods:
- name: getCachedState(state)
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getCachedState:member(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: getCachedState(state)
summary: This virtual method returns a subset of the state object that will be cached by the client.
remarks: 'If not overriden, this will return an empty object.'
isPreview: true
isDeprecated: false
syntax:
content: |-
/** @virtual */
protected getCachedState(state: TState): Partial<TState>;
parameters:
- id: state
description: A shallow clone of the AdaptiveCardExtension state object.
type: TState
return:
type: Partial<TState>
description: ''
- name: getCacheSettings()
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getCacheSettings:member(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: getCacheSettings()
summary: Override the default cache settings.
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: |-
/** @virtual */
protected getCacheSettings(): Partial<ICacheSettings>;
return:
type: 'Partial<<xref uid="@microsoft/sp-adaptive-card-extension-base!ICacheSettings:interface" />>'
description: ''
- name: getPropertyPaneConfiguration()
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getPropertyPaneConfiguration:member(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: getPropertyPaneConfiguration()
summary: >-
Get the Property Pane configuration for this Adaptive Card Extension. If an Adaptive Card Extension wants to use
the Property Pane, then this method must be overriden.
remarks: >-
Property Pane resources can be defer loaded to reduce bundle size. See
[BaseAdaptiveCardExtension.loadPropertyPaneResources()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23loadPropertyPaneResources:member(1))<!--
-->.
isPreview: false
isDeprecated: false
syntax:
content: |-
/** @virtual */
protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;
return:
type: '<xref uid="@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface" />'
description: ''
- name: loadPropertyPaneResources()
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#loadPropertyPaneResources:member(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: loadPropertyPaneResources()
summary: API to enable asynchronous loading of Property Pane related resources of the Adaptive Card Extension.
remarks: >-
No Property Pane events will be raised until this method resolves except for
`PropertyPaneConfigurationComplete`<!-- -->, which can be used to clean up any pending resources.
isPreview: false
isDeprecated: false
syntax:
content: |-
/** @virtual */
protected loadPropertyPaneResources(): Promise<void>;
return:
type: Promise<void>
description: ''
- name: 'onAfterDeserialize(deserializedProperties, dataVersion)'
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onAfterDeserialize:member(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: 'onAfterDeserialize(deserializedProperties, dataVersion)'
summary: Lifecycle method called before the property bag is populated with the deserialized property object.
remarks: >-
The default implementation is a no-op. An Adaptive Card Extension developer can override this API if the
deserialized object does not fully reflect the initial state of the property bag. This gives the Adaptive Card
Extension developer a chance to populate the property bag right after the data is deserialized to an object.
An important scenario to use deserialize is upgrading. An upgraded Adaptive Card Extension may load the data that
was serialized by an older version of the Adaptive Card Extension that supported a different schema of the
property bag, resulting the deserialized object to be incosistent with the current schema of the property bag. The
developer can use `onAfterDeserialize` to check the dataVersion and fix the property bag.
isPreview: false
isDeprecated: false
syntax:
content: |-
/** @virtual */
protected onAfterDeserialize(deserializedProperties: any, dataVersion: Version): TProperties;
parameters:
- id: deserializedProperties
description: >-
The object deserialized from the stored data. Note that the schema of this object is not necessarily
consistent with the current property bag, because the serialization could have been done by an older version
of the Adaptive Card Extension
type: any
- id: dataVersion
description: >-
The data version of the stored data being deserialized. You can use this value to determine if the data was
serialized by an older Adaptive Card Extension. Adaptive Card Extensions can define their data version by
overriding the dataVersion property.
type: '<xref uid="@microsoft/sp-core-library!Version:class" />'
return:
type: TProperties
description: The property bag of the Adaptive Card Extension
- name: onAfterPropertiesUpdatedExternally(prevProperties)
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onAfterPropertiesUpdatedExternally:member(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: onAfterPropertiesUpdatedExternally(prevProperties)
summary: >-
Lifecycle method called after the Adaptive Card Extension's properties have been updated by a source other than
the property pane (except for isolated Adaptive Card Extensions).
remarks: 'For isolated Adaptive Card Extensions, this lifecycle is invoked instead of `onPropertyPaneFieldChanged`<!-- -->.'
isPreview: false
isDeprecated: false
syntax:
content: |-
/** @virtual */
onAfterPropertiesUpdatedExternally(prevProperties: TProperties): void;
parameters:
- id: prevProperties
description: The Adaptive Card Extension properties before the update.
type: TProperties
return:
type: void
description: ''
- name: onBeforeAction(action)
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onBeforeAction:member(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: onBeforeAction(action)
summary: >-
Lifecycle method called before Action is passed to
[IAdaptiveCardExtensionActionView.onAction](xref:@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionActionView%23onAction:member)<!--
-->.
remarks: This method is not intended to be used to cancel the action or to change the flow.
isPreview: false
isDeprecated: false
syntax:
content: |-
/** @virtual */
onBeforeAction(action: IOnBeforeActionArguments): void;
parameters:
- id: action
description: >-
[IOnBeforeActionArguments](xref:@microsoft/sp-adaptive-card-extension-base!IOnBeforeActionArguments:type)
for the current action.
type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IOnBeforeActionArguments:type" />'
return:
type: void
description: ''
- name: onBeforeSerialize()
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onBeforeSerialize:member(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: onBeforeSerialize()
summary: Lifecycle method called before serialization.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: |-
/** @virtual */
onBeforeSerialize(): void;
return:
type: void
description: ''
- name: onDisplayModeChanged(oldDisplayMode)
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onDisplayModeChanged:member(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: onDisplayModeChanged(oldDisplayMode)
summary: 'Lifecycle method called after the [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum) changed.'
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: |-
/** @virtual */
protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void;
parameters:
- id: oldDisplayMode
description: The old display mode.
type: '<xref uid="@microsoft/sp-core-library!DisplayMode:enum" />'
return:
type: void
description: ''
- name: onDispose()
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onDispose:member(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: onDispose()
summary: Lifecycle method called before disposing the Adaptive Card Extension.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: |-
/** @virtual */
onDispose(): void;
return:
type: void
description: ''
- name: onInit()
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onInit:member(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: onInit()
summary: Lifecycle method called during initialization.
remarks: >-
Asynchronous data fetches should be started during this lifecycle. Rendering can either be dependent on the result
or, if resolved immediately, a fetching data state can be rendered.
isPreview: false
isDeprecated: false
syntax:
content: |-
/** @virtual */
onInit(): Promise<void>;
return:
type: Promise<void>
description: ''
- name: onInit(cachedLoadParameters)
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onInit:member(2)'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: onInit(cachedLoadParameters)
summary: Lifecycle method called during initialization.
remarks: >-
Asynchronous data fetches should be started during this lifecycle. Rendering can either be dependent on the result
or, if resolved immediately, a fetching data state can be rendered.
isPreview: true
isDeprecated: false
syntax:
content: |-
/** @virtual */
onInit(cachedLoadParameters?: ICachedLoadParameters): Promise<void>;
parameters:
- id: cachedLoadParameters
description: >-
Parameters containing the cached state object (see
[BaseAdaptiveCardExtension.getCachedState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23getCachedState:member(1))<!--
-->), which can be used to rehydrate the AdaptiveCardExtension. If undefined, the AdaptiveCardExtension was
not cached or the cache expired.
type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters:interface" />'
return:
type: Promise<void>
description: ''
- name: onNotificationReceived(notificationArguments)
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onNotificationReceived:member(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: onNotificationReceived(notificationArguments)
summary: Lifecycle method called when a notification is received for this Adaptive Card Extension.
remarks: >-
Only one Adaptive Card Extension can handle a notification event. If the event is handled, then propagation is
finished.
isPreview: true
isDeprecated: false
syntax:
content: >-
/** @virtual */
onNotificationReceived(notificationArguments: Readonly<INotificationArguments<{}>>): INotificationResponse |
undefined;
parameters:
- id: notificationArguments
description: >-
The
[INotificationArguments](xref:@microsoft/sp-adaptive-card-extension-base!INotificationArguments:interface)
for the current notification event.
type: >-
Readonly<<xref uid="@microsoft/sp-adaptive-card-extension-base!INotificationArguments:interface"
/><{}>>
return:
type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!INotificationResponse:interface" /> | undefined'
description: A registered quick view id to open or undefined.
- name: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)'
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onPropertyPaneFieldChanged:member(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)'
summary: Lifecycle method called when a Property Pane field is changed.
remarks: This is invoked for reactive Property Panes.
isPreview: false
isDeprecated: false
syntax:
content: |-
/** @virtual */
protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void;
parameters:
- id: propertyPath
description: >-
JSON path of the property in the property bag. In the case of custom field, if no target property is
provided then a custom value is assigned, which will be in the form of `__CustomField_<key provided when the
custom field is created>`<!-- -->.
type: string
- id: oldValue
description: Old value of the property. This value could be undefined/empty in the case of custom field.
type: any
- id: newValue
description: New value of the property. This value could be undefined/empty in the case of custom field.
type: any
return:
type: void
description: ''
- name: onRenderTypeChanged(oldRenderType)
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onRenderTypeChanged:member(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: onRenderTypeChanged(oldRenderType)
summary: >-
Lifecycle method called when the [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type)
changes.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: |-
/** @virtual */
protected onRenderTypeChanged(oldRenderType: RenderType): void;
parameters:
- id: oldRenderType
description: 'The previous [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type)<!-- -->.'
type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!RenderType:type" />'
return:
type: void
description: ''
- name: renderCard()
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderCard:member(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: renderCard()
summary: The id of the initial Card view.
remarks: 'By default, this returns undefined and will render a default Card view.'
isPreview: false
isDeprecated: false
syntax:
content: |-
/** @virtual */
protected renderCard(): string | undefined;
return:
type: string | undefined
description: ''
- name: renderCompleted(didUpdate)
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderCompleted:member(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: renderCompleted(didUpdate)
summary: >-
Lifecycle method that signifies ACE has finished loading. When this API is called, performance data will be
generated. Depending on `didUpdate` parameter, end marker for the rendering lifecycle can change. If an ACE
received LKG data and does NOT need to update, render is completed when LKG is used. If an ACE received LKG data
and DOES need to update, render is completed when new render arguments are used. If an ACE does not receive LKG
data, render is completed when new render arguments are used.
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: 'renderCompleted(didUpdate: boolean): void;'
parameters:
- id: didUpdate
description: boolean value indicating if ACE has updated.
type: boolean
return:
type: void
description: ''
- name: setState(newState)
uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#setState:member(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: setState(newState)
summary: Update the state of the Adaptive Card Extension and re-render.
remarks: >-
[BaseAdaptiveCardExtension.state](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23state:member)
must have been initialized before calling
[BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1))<!--
-->.
isPreview: false
isDeprecated: false
syntax:
content: 'setState(newState?: Partial<TState>): void;'
parameters:
- id: newState
description: The new state to set.
type: Partial<TState>
return:
type: void
description: ''
extends: '<xref uid="@microsoft/sp-component-base!BaseComponent:class" />'