1 | import { _SPInstance, _SPCollection } from "../spqueryable.js";
|
2 |
|
3 |
|
4 |
|
5 |
|
6 | export declare class _TermStore extends _SPInstance<ITermStoreInfo> {
|
7 | |
8 |
|
9 |
|
10 | get groups(): ITermGroups;
|
11 | |
12 |
|
13 |
|
14 | get sets(): ITermSets;
|
15 | |
16 |
|
17 |
|
18 |
|
19 |
|
20 |
|
21 | searchTerm(params: ISearchTermParams): Promise<Required<Pick<ITermInfo, SearchTermPickedProps>>[]>;
|
22 | |
23 |
|
24 |
|
25 |
|
26 |
|
27 |
|
28 | update(props: Partial<Pick<ITermStoreInfo, "defaultLanguageTag" | "languageTags">>): Promise<ITermStoreInfo>;
|
29 | }
|
30 | export interface ITermStore extends _TermStore {
|
31 | }
|
32 | export declare const TermStore: import("../spqueryable.js").ISPInvokableFactory<ITermStore>;
|
33 | export declare class _TermGroups extends _SPCollection<ITermGroupInfo[]> {
|
34 | |
35 |
|
36 |
|
37 |
|
38 |
|
39 | getById(id: string): ITermGroup;
|
40 | |
41 |
|
42 |
|
43 |
|
44 |
|
45 | add(props: Partial<Omit<ITermGroupInfo, "id" | "createdDateTime" | "lastModifiedDateTime" | "type">>): Promise<ITermGroupInfo>;
|
46 | }
|
47 | export interface ITermGroups extends _TermGroups {
|
48 | }
|
49 | export declare const TermGroups: import("../spqueryable.js").ISPInvokableFactory<ITermGroups>;
|
50 | export declare class _TermGroup extends _SPInstance<ITermGroupInfo> {
|
51 | |
52 |
|
53 |
|
54 | get sets(): ITermSets;
|
55 | |
56 |
|
57 |
|
58 |
|
59 |
|
60 | delete(): Promise<void>;
|
61 | }
|
62 | export interface ITermGroup extends _TermGroup {
|
63 | }
|
64 | export declare const TermGroup: import("../spqueryable.js").ISPInvokableFactory<ITermGroup>;
|
65 | export declare class _TermSets extends _SPCollection<ITermSetInfo[]> {
|
66 | |
67 |
|
68 |
|
69 |
|
70 |
|
71 | getById(id: string): ITermSet;
|
72 | |
73 |
|
74 |
|
75 |
|
76 |
|
77 | add(props: Partial<ITermSetCreateParams>): Promise<ITermGroupInfo>;
|
78 | }
|
79 | export interface ITermSets extends _TermSets {
|
80 | }
|
81 | export declare const TermSets: import("../spqueryable.js").ISPInvokableFactory<ITermSets>;
|
82 | export declare class _TermSet extends _SPInstance<ITermSetInfo> {
|
83 | |
84 |
|
85 |
|
86 | get terms(): ITerms;
|
87 | get parentGroup(): ITermGroup;
|
88 | get children(): IChildren;
|
89 | get relations(): IRelations;
|
90 | getTermById(id: string): ITerm;
|
91 | |
92 |
|
93 |
|
94 |
|
95 |
|
96 |
|
97 | update(props: Partial<Pick<ITermSetInfo, "localizedNames" | "description" | "properties">>): Promise<ITermSetInfo>;
|
98 | |
99 |
|
100 |
|
101 |
|
102 |
|
103 | delete(): Promise<void>;
|
104 | |
105 |
|
106 |
|
107 |
|
108 |
|
109 |
|
110 | getAllChildrenAsOrderedTree(props?: Partial<IGetOrderedTreeProps>): Promise<IOrderedTermInfo[]>;
|
111 | }
|
112 | export interface ITermSet extends _TermSet {
|
113 | }
|
114 | export declare const TermSet: import("../spqueryable.js").ISPInvokableFactory<ITermSet>;
|
115 | export declare class _Children extends _SPCollection<ITermInfo[]> {
|
116 | |
117 |
|
118 |
|
119 |
|
120 |
|
121 | add(props: Pick<ITermInfo, "labels">): Promise<ITermInfo>;
|
122 | }
|
123 | export interface IChildren extends _Children {
|
124 | }
|
125 | export declare const Children: import("../spqueryable.js").ISPInvokableFactory<IChildren>;
|
126 | export declare class _Terms extends _SPCollection<ITermInfo[]> {
|
127 | |
128 |
|
129 |
|
130 |
|
131 |
|
132 | getById(id: string): ITerm;
|
133 | }
|
134 | export interface ITerms extends _Terms {
|
135 | }
|
136 | export declare const Terms: import("../spqueryable.js").ISPInvokableFactory<ITerms>;
|
137 | export declare class _Term extends _SPInstance<ITermInfo> {
|
138 | get children(): IChildren;
|
139 | get relations(): IRelations;
|
140 | get set(): ITermSet;
|
141 | |
142 |
|
143 |
|
144 |
|
145 |
|
146 |
|
147 | update(props: Partial<Pick<ITermInfo, "labels" | "descriptions" | "properties">>): Promise<ITermSetInfo>;
|
148 | |
149 |
|
150 |
|
151 |
|
152 |
|
153 | delete(): Promise<void>;
|
154 | }
|
155 | export interface ITerm extends _Term {
|
156 | }
|
157 | export declare const Term: import("../spqueryable.js").ISPInvokableFactory<ITerm>;
|
158 | export declare class _Relations extends _SPCollection<IRelationInfo[]> {
|
159 | |
160 |
|
161 |
|
162 |
|
163 |
|
164 | add(props: Omit<IRelationCreateInfo, "id">): Promise<IRelationCreateInfo>;
|
165 | }
|
166 | export interface IRelations extends _Relations {
|
167 | }
|
168 | export declare const Relations: import("../spqueryable.js").ISPInvokableFactory<IRelations>;
|
169 | export interface ITermStoreInfo {
|
170 | id: string;
|
171 | name: string;
|
172 | defaultLanguageTag: string;
|
173 | languageTags: string[];
|
174 | administrators?: ITaxonomyUserInfo;
|
175 | }
|
176 | export interface ITermGroupInfo {
|
177 | id: string;
|
178 | description: string;
|
179 | name: string;
|
180 | displayName: string;
|
181 | createdDateTime: string;
|
182 | lastModifiedDateTime: string;
|
183 | type: string;
|
184 | scope: "global" | "system" | "siteCollection";
|
185 | }
|
186 | export interface ITermSetInfo {
|
187 | id: string;
|
188 | localizedNames: {
|
189 | name: string;
|
190 | languageTag: string;
|
191 | }[];
|
192 | description: string;
|
193 | createdDateTime: string;
|
194 | customSortOrder: string[];
|
195 | properties?: ITaxonomyProperty[];
|
196 | childrenCount: number;
|
197 | groupId: string;
|
198 | isOpen: boolean;
|
199 | isAvailableForTagging: boolean;
|
200 | contact: string;
|
201 | }
|
202 | export interface ITermSetCreateParams {
|
203 | localizedNames: {
|
204 | name: string;
|
205 | languageTag: string;
|
206 | }[];
|
207 | description?: string;
|
208 | properties?: ITaxonomyProperty[];
|
209 | |
210 |
|
211 |
|
212 | parentGroup?: {
|
213 | id: string;
|
214 | };
|
215 | isOpen?: boolean;
|
216 | isAvailableForTagging?: boolean;
|
217 | contact?: string;
|
218 | }
|
219 | export interface ITermInfo {
|
220 | childrenCount: number;
|
221 | id: string;
|
222 | labels: {
|
223 | name: string;
|
224 | isDefault: boolean;
|
225 | languageTag: string;
|
226 | }[];
|
227 | createdDateTime: string;
|
228 | customSortOrder?: ITermSortOrderInfo[];
|
229 | lastModifiedDateTime: string;
|
230 | descriptions: {
|
231 | description: string;
|
232 | languageTag: string;
|
233 | }[];
|
234 | properties?: ITaxonomyProperty[];
|
235 | localProperties?: ITaxonomyLocalProperty[];
|
236 | isDeprecated: boolean;
|
237 | isAvailableForTagging: {
|
238 | setId: string;
|
239 | isAvailable: boolean;
|
240 | }[];
|
241 | topicRequested?: boolean;
|
242 | parent?: ITermInfo;
|
243 | set?: ITermSetInfo;
|
244 | relations?: IRelationInfo[];
|
245 | children?: ITermInfo[];
|
246 | }
|
247 | export interface ISearchTermParams {
|
248 | |
249 |
|
250 |
|
251 | label: string;
|
252 | |
253 |
|
254 |
|
255 | setId?: string;
|
256 | |
257 |
|
258 |
|
259 | parentTermId?: string;
|
260 | |
261 |
|
262 |
|
263 | languageTag?: string;
|
264 | |
265 |
|
266 |
|
267 | stringMatchOption?: "ExactMatch" | "StartsWith";
|
268 | }
|
269 | declare type SearchTermPickedProps = "childrenCount" | "createdDateTime" | "descriptions" | "id" | "isAvailableForTagging" | "isDeprecated" | "labels" | "lastModifiedDateTime" | "set";
|
270 | export interface ITermSortOrderInfo {
|
271 | setId: string;
|
272 | order: string[];
|
273 | }
|
274 | export interface IOrderedTermInfo extends ITermInfo {
|
275 | children: ITermInfo[];
|
276 | defaultLabel: string;
|
277 | }
|
278 | export interface IRelationInfo {
|
279 | id: string;
|
280 | relationType: string;
|
281 | }
|
282 | export interface IRelationCreateInfo {
|
283 | id: string;
|
284 | relationship: "pin" | "reuse";
|
285 | fromTerm: {
|
286 | id: string;
|
287 | };
|
288 | toTerm: {
|
289 | id: string;
|
290 | };
|
291 | set: {
|
292 | id: string;
|
293 | };
|
294 | }
|
295 | export interface ITaxonomyUserInfo {
|
296 | user: {
|
297 | displayName: string;
|
298 | email: string;
|
299 | id: string;
|
300 | };
|
301 | }
|
302 | export interface ITaxonomyProperty {
|
303 | key: string;
|
304 | value: string;
|
305 | }
|
306 | export interface ITaxonomyLocalProperty {
|
307 | setId: string;
|
308 | properties: ITaxonomyProperty[];
|
309 | }
|
310 | export interface IGetOrderedTreeProps {
|
311 | retrieveProperties: boolean;
|
312 | }
|
313 | export {};
|
314 |
|
\ | No newline at end of file |