-
Notifications
You must be signed in to change notification settings - Fork 16
/
idynamicdatasource.yml
194 lines (190 loc) · 8.02 KB
/
idynamicdatasource.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
### YamlMime:TSType
name: IDynamicDataSource
uid: '@microsoft/sp-dynamic-data!IDynamicDataSource:interface'
package: '@microsoft/sp-dynamic-data!'
fullName: IDynamicDataSource
summary: >-
Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to identify the data sources and API to
get the data.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: id
uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#id:member'
package: '@microsoft/sp-dynamic-data!'
fullName: id
summary: Id of the Dynamic Data Source.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'id: string;'
return:
type: string
- name: metadata
uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#metadata:member'
package: '@microsoft/sp-dynamic-data!'
fullName: metadata
summary: Metadata of the Dynamic Data Source.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'metadata: IDynamicDataSourceMetadata;'
return:
type: '<xref uid="@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface" />'
methods:
- name: allowedEventsAsync()
uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#allowedEventsAsync:member(1)'
package: '@microsoft/sp-dynamic-data!'
fullName: allowedEventsAsync()
summary: >-
Returns list of allowed events on the dynamic data source. When this api returns a non-empty result, then source
must define 'sendData' api.
If this api is not defined or returns an empty map, then no consumer will be able to talk to this source.
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: 'allowedEventsAsync?(): Promise<ReadonlyArray<IDynamicDataEventDefinition>>;'
return:
type: >-
Promise<ReadonlyArray<<xref uid="@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface"
/>>>
description: ''
- name: getAnnotatedPropertyValue(propertyId)
uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValue:member(1)'
package: '@microsoft/sp-dynamic-data!'
fullName: getAnnotatedPropertyValue(propertyId)
summary: >-
Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls
back to whatever 'getPropertyValue' as the sample value and metadata would be undefined.
remarks: ''
isPreview: false
isDeprecated: true
customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getAsyncAnnotatedPropertyValue`'
syntax:
content: 'getAnnotatedPropertyValue(propertyId: string): IDynamicDataAnnotatedPropertyValue;'
parameters:
- id: propertyId
description: One of the property ids exposed from the dynamic data source.
type: string
return:
type: '<xref uid="@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface" />'
description: ''
- name: getAnnotatedPropertyValueAsync(propertyId)
uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValueAsync:member(1)'
package: '@microsoft/sp-dynamic-data!'
fullName: getAnnotatedPropertyValueAsync(propertyId)
summary: >-
Given a property id, returns its annotated value. If the source doesn't supply the annotated value, then it falls
back to whatever 'getPropertyValue' as the sample value and metadata would be undefined.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'getAnnotatedPropertyValueAsync(propertyId: string): Promise<IDynamicDataAnnotatedPropertyValue>;'
parameters:
- id: propertyId
description: Property id for which the value is requested.
type: string
return:
type: 'Promise<<xref uid="@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface" />>'
description: ''
- name: getPropertyDefinitions()
uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions:member(1)'
package: '@microsoft/sp-dynamic-data!'
fullName: getPropertyDefinitions()
summary: >-
Returns all the property definitions for dynamic data. This needs to be overridden by the implementation of the
component.
remarks: ''
isPreview: false
isDeprecated: true
customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getPropertyDefinitionsAsync`'
syntax:
content: 'getPropertyDefinitions(): ReadonlyArray<IDynamicDataPropertyDefinition>;'
return:
type: 'ReadonlyArray<<xref uid="@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface" />>'
description: ''
- name: getPropertyDefinitionsAsync()
uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitionsAsync:member(1)'
package: '@microsoft/sp-dynamic-data!'
fullName: getPropertyDefinitionsAsync()
summary: >-
Returns all the property definitions for dynamic data. This needs to be overridden by the implementation of the
component.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'getPropertyDefinitionsAsync(): Promise<ReadonlyArray<IDynamicDataPropertyDefinition>>;'
return:
type: >-
Promise<ReadonlyArray<<xref uid="@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface"
/>>>
description: ''
- name: getPropertyValue(propertyId)
uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValue:member(1)'
package: '@microsoft/sp-dynamic-data!'
fullName: getPropertyValue(propertyId)
summary: >-
Given a property id, returns the value of the property. This needs to be overridden by the implementation of the
component.
remarks: ''
isPreview: false
isDeprecated: true
customDeprecatedMessage: '- This API is deprecated. Please use the asynchronous version `getAsyncPropertyValue`'
syntax:
content: 'getPropertyValue(propertyId: string): any;'
parameters:
- id: propertyId
description: Property id for which the value is requested.
type: string
return:
type: any
description: ''
- name: getPropertyValueAsync(propertyId)
uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyValueAsync:member(1)'
package: '@microsoft/sp-dynamic-data!'
fullName: getPropertyValueAsync(propertyId)
summary: >-
Given a property id, returns the value of the property. This needs to be overridden by the implementation of the
component.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'getPropertyValueAsync(propertyId: string): Promise<any>;'
parameters:
- id: propertyId
description: Property id for which the value is requested.
type: string
return:
type: Promise<any>
description: ''
- name: 'sendEvent(eventName, data)'
uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#sendEvent:member(1)'
package: '@microsoft/sp-dynamic-data!'
fullName: 'sendEvent(eventName, data)'
summary: >-
If defined, enables the consumer to send data to the associated dynamic data source. Then source can act
accordingly.
Invoking this api throws an error when the passed in 'eventName' is not one of the allowed events on the source.
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: 'sendEvent?(eventName: string, data: any): void;'
parameters:
- id: eventName
description: A case-sensitive string representing the name of the event.
type: string
- id: data
description: Data to be sent to the dynamic data source.
type: any
return:
type: void
description: ''