1 | import { _SPCollection, _SPInstance, ISPQueryable, ISPCollection, IDeleteableWithETag } from "../spqueryable.js";
|
2 | import { IChangeQuery } from "../types.js";
|
3 | import { IBasePermissions } from "../security/types.js";
|
4 | import { IFieldInfo } from "../fields/types.js";
|
5 | import { IFormInfo } from "../forms/types.js";
|
6 | import { IFolderInfo } from "../folders/types.js";
|
7 | import { IViewInfo } from "../views/types.js";
|
8 | import { IUserCustomActionInfo } from "../user-custom-actions/types.js";
|
9 | import { IResourcePath } from "../utils/to-resource-path.js";
|
10 | export declare class _Lists extends _SPCollection<IListInfo[]> {
|
11 | |
12 |
|
13 |
|
14 |
|
15 |
|
16 | getById(id: string): IList;
|
17 | |
18 |
|
19 |
|
20 |
|
21 |
|
22 | getByTitle(title: string): IList;
|
23 | |
24 |
|
25 |
|
26 |
|
27 |
|
28 |
|
29 |
|
30 |
|
31 |
|
32 | add(title: string, desc?: string, template?: number, enableContentTypes?: boolean, additionalSettings?: Partial<IListInfo>): Promise<IListAddResult>;
|
33 | |
34 |
|
35 |
|
36 |
|
37 |
|
38 |
|
39 |
|
40 |
|
41 |
|
42 | ensure(title: string, desc?: string, template?: number, enableContentTypes?: boolean, additionalSettings?: Partial<IListInfo>): Promise<IListEnsureResult>;
|
43 | |
44 |
|
45 |
|
46 | ensureSiteAssetsLibrary(): Promise<IList>;
|
47 | |
48 |
|
49 |
|
50 | ensureSitePagesLibrary(): Promise<IList>;
|
51 | }
|
52 | export interface ILists extends _Lists {
|
53 | }
|
54 | export declare const Lists: import("../spqueryable.js").ISPInvokableFactory<ILists>;
|
55 | export declare class _List extends _SPInstance<IListInfo> {
|
56 | delete: (this: ISPQueryable<any>, eTag?: string) => Promise<void>;
|
57 | |
58 |
|
59 |
|
60 |
|
61 | get effectiveBasePermissions(): ISPQueryable;
|
62 | |
63 |
|
64 |
|
65 |
|
66 | get eventReceivers(): ISPCollection;
|
67 | |
68 |
|
69 |
|
70 |
|
71 | get relatedFields(): ISPQueryable;
|
72 | |
73 |
|
74 |
|
75 |
|
76 | get informationRightsManagementSettings(): ISPQueryable;
|
77 | |
78 |
|
79 |
|
80 |
|
81 |
|
82 |
|
83 | update(properties: Partial<IListInfo>, eTag?: string): Promise<IListUpdateResult>;
|
84 | |
85 |
|
86 |
|
87 |
|
88 | getChanges(query: IChangeQuery): Promise<any>;
|
89 | |
90 |
|
91 |
|
92 |
|
93 |
|
94 | getItemsByCAMLQuery(query: ICamlQuery, ...expands: string[]): Promise<any>;
|
95 | |
96 |
|
97 |
|
98 |
|
99 | getListItemChangesSinceToken(query: IChangeLogItemQuery): Promise<string>;
|
100 | |
101 |
|
102 |
|
103 | recycle(): Promise<string>;
|
104 | |
105 |
|
106 |
|
107 |
|
108 | renderListData(viewXml: string): Promise<IRenderListData>;
|
109 | |
110 |
|
111 |
|
112 |
|
113 |
|
114 |
|
115 |
|
116 | renderListDataAsStream(parameters: IRenderListDataParameters, overrideParameters?: any, query?: Map<string, string>): Promise<IRenderListDataAsStreamResult>;
|
117 | |
118 |
|
119 |
|
120 |
|
121 |
|
122 |
|
123 | renderListFormData(itemId: number, formId: string, mode: ControlMode): Promise<IListFormData>;
|
124 | |
125 |
|
126 |
|
127 | reserveListItemId(): Promise<number>;
|
128 | |
129 |
|
130 |
|
131 |
|
132 |
|
133 |
|
134 |
|
135 |
|
136 |
|
137 | addValidateUpdateItemUsingPath(formValues: IListItemFormUpdateValue[], decodedUrl: string, bNewDocumentUpdate?: boolean, checkInComment?: string, additionalProps?: {
|
138 | |
139 |
|
140 |
|
141 | leafName?: string;
|
142 | |
143 |
|
144 |
|
145 | objectType?: 0 | 1 | 2;
|
146 | }): Promise<IListItemFormUpdateValue[]>;
|
147 | |
148 |
|
149 |
|
150 | getParentInfos(): Promise<IListParentInfos>;
|
151 | }
|
152 | export interface IList extends _List, IDeleteableWithETag {
|
153 | }
|
154 | export declare const List: import("../spqueryable.js").ISPInvokableFactory<IList>;
|
155 |
|
156 |
|
157 |
|
158 | export interface IListAddResult {
|
159 | list: IList;
|
160 | data: IListInfo;
|
161 | }
|
162 |
|
163 |
|
164 |
|
165 | export interface IListUpdateResult {
|
166 | list: IList;
|
167 | data: IListInfo;
|
168 | }
|
169 |
|
170 |
|
171 |
|
172 | export interface IListEnsureResult {
|
173 | list: IList;
|
174 | created: boolean;
|
175 | data: IListInfo;
|
176 | }
|
177 |
|
178 |
|
179 |
|
180 | export interface ICamlQuery {
|
181 | |
182 |
|
183 |
|
184 | DatesInUtc?: boolean;
|
185 | |
186 |
|
187 |
|
188 | FolderServerRelativeUrl?: string;
|
189 | |
190 |
|
191 |
|
192 | ListItemCollectionPosition?: IListItemCollectionPosition;
|
193 | |
194 |
|
195 |
|
196 | ViewXml?: string;
|
197 | }
|
198 |
|
199 |
|
200 |
|
201 | export interface IListItemCollectionPosition {
|
202 | |
203 |
|
204 |
|
205 | PagingInfo: string;
|
206 | }
|
207 |
|
208 |
|
209 |
|
210 | export interface IChangeLogItemQuery {
|
211 | |
212 |
|
213 |
|
214 | ChangeToken?: string;
|
215 | |
216 |
|
217 |
|
218 | Contains?: string;
|
219 | |
220 |
|
221 |
|
222 | Query?: string;
|
223 | |
224 |
|
225 |
|
226 | QueryOptions?: string;
|
227 | |
228 |
|
229 |
|
230 | RowLimit?: string;
|
231 | |
232 |
|
233 |
|
234 | ViewFields?: string;
|
235 | |
236 |
|
237 |
|
238 | ViewName?: string;
|
239 | }
|
240 |
|
241 |
|
242 |
|
243 | export interface IListFormData {
|
244 | ContentType?: string;
|
245 | Title?: string;
|
246 | Author?: string;
|
247 | Editor?: string;
|
248 | Created?: Date;
|
249 | Modified: Date;
|
250 | Attachments?: any;
|
251 | ListSchema?: any;
|
252 | FormControlMode?: number;
|
253 | FieldControlModes?: {
|
254 | Title?: number;
|
255 | Author?: number;
|
256 | Editor?: number;
|
257 | Created?: number;
|
258 | Modified?: number;
|
259 | Attachments?: number;
|
260 | };
|
261 | WebAttributes?: {
|
262 | WebUrl?: string;
|
263 | EffectivePresenceEnabled?: boolean;
|
264 | AllowScriptableWebParts?: boolean;
|
265 | PermissionCustomizePages?: boolean;
|
266 | LCID?: number;
|
267 | CurrentUserId?: number;
|
268 | };
|
269 | ItemAttributes?: {
|
270 | Id?: number;
|
271 | FsObjType?: number;
|
272 | ExternalListItem?: boolean;
|
273 | Url?: string;
|
274 | EffectiveBasePermissionsLow?: number;
|
275 | EffectiveBasePermissionsHigh?: number;
|
276 | };
|
277 | ListAttributes?: {
|
278 | Id?: string;
|
279 | BaseType?: number;
|
280 | Direction?: string;
|
281 | ListTemplateType?: number;
|
282 | DefaultItemOpen?: number;
|
283 | EnableVersioning?: boolean;
|
284 | };
|
285 | CSRCustomLayout?: boolean;
|
286 | PostBackRequired?: boolean;
|
287 | PreviousPostBackHandled?: boolean;
|
288 | UploadMode?: boolean;
|
289 | SubmitButtonID?: string;
|
290 | ItemContentTypeName?: string;
|
291 | ItemContentTypeId?: string;
|
292 | JSLinks?: string;
|
293 | }
|
294 |
|
295 |
|
296 |
|
297 | export declare enum RenderListDataOptions {
|
298 | None = 0,
|
299 | ContextInfo = 1,
|
300 | ListData = 2,
|
301 | ListSchema = 4,
|
302 | MenuView = 8,
|
303 | ListContentType = 16,
|
304 | FileSystemItemId = 32,
|
305 | ClientFormSchema = 64,
|
306 | QuickLaunch = 128,
|
307 | Spotlight = 256,
|
308 | Visualization = 512,
|
309 | ViewMetadata = 1024,
|
310 | DisableAutoHyperlink = 2048,
|
311 | EnableMediaTAUrls = 4096,
|
312 | ParentInfo = 8192,
|
313 | PageContextInfo = 16384,
|
314 | ClientSideComponentManifest = 32768
|
315 | }
|
316 |
|
317 |
|
318 |
|
319 | export interface IRenderListDataParameters {
|
320 | AddRequiredFields?: boolean;
|
321 | AllowMultipleValueFilterForTaxonomyFields?: boolean;
|
322 | AudienceTarget?: boolean;
|
323 | DatesInUtc?: boolean;
|
324 | DeferredRender?: boolean;
|
325 | ExpandGroups?: boolean;
|
326 | FirstGroupOnly?: boolean;
|
327 | FolderServerRelativeUrl?: string;
|
328 | ImageFieldsToTryRewriteToCdnUrls?: string;
|
329 | MergeDefaultView?: boolean;
|
330 | OriginalDate?: boolean;
|
331 | OverrideViewXml?: string;
|
332 | Paging?: string;
|
333 | ReplaceGroup?: boolean;
|
334 | RenderOptions?: RenderListDataOptions[] | number;
|
335 | ViewXml?: string;
|
336 | }
|
337 |
|
338 |
|
339 |
|
340 | export interface IListItemFormUpdateValue {
|
341 | |
342 |
|
343 |
|
344 | ErrorMessage?: string;
|
345 | |
346 |
|
347 |
|
348 | FieldName?: string;
|
349 | |
350 |
|
351 |
|
352 | FieldValue?: string;
|
353 | |
354 |
|
355 |
|
356 | HasException?: boolean;
|
357 | }
|
358 |
|
359 |
|
360 |
|
361 | export interface IRenderListData {
|
362 | Row: any[];
|
363 | FirstRow: number;
|
364 | FolderPermissions: string;
|
365 | LastRow: number;
|
366 | FilterLink: string;
|
367 | ForceNoHierarchy: string;
|
368 | HierarchyHasIndention: string;
|
369 | }
|
370 |
|
371 |
|
372 |
|
373 | export declare enum ControlMode {
|
374 | Display = 1,
|
375 | Edit = 2,
|
376 | New = 3
|
377 | }
|
378 | export interface IListInfo {
|
379 | AllowContentTypes: boolean;
|
380 | AllowDeletion: boolean;
|
381 | BaseTemplate: number;
|
382 | BaseType: any;
|
383 | BrowserFileHandling: any;
|
384 | ContentTypes: any[];
|
385 | ContentTypesEnabled: boolean;
|
386 | CrawlNonDefaultViews: boolean;
|
387 | CreatablesInfo: any;
|
388 | Created: string;
|
389 | CurrentChangeToken: any;
|
390 | CustomActionElements: any[];
|
391 | DataSource: any;
|
392 | DefaultContentApprovalWorkflowId: string;
|
393 | DefaultDisplayFormUrl: string;
|
394 | DefaultEditFormUrl: string;
|
395 | DefaultNewFormUrl: string;
|
396 | DefaultView: any;
|
397 | DefaultViewPath: any;
|
398 | DefaultViewUrl: string;
|
399 | Description: string;
|
400 | DescriptionResource: any;
|
401 | Direction: string;
|
402 | DocumentTemplateUrl: string;
|
403 | DraftVersionVisibility: any;
|
404 | EffectiveBasePermissions: IBasePermissions;
|
405 | EffectiveBasePermissionsForUI: IBasePermissions;
|
406 | EnableAssignToEmail: boolean;
|
407 | EnableAttachments: boolean;
|
408 | EnableFolderCreation: boolean;
|
409 | EnableMinorVersions: boolean;
|
410 | EnableModeration: boolean;
|
411 | EnableRequestSignOff: boolean;
|
412 | EnableVersioning: boolean;
|
413 | EntityTypeName: string;
|
414 | EventReceivers: any[];
|
415 | ExcludeFromOfflineClient: boolean;
|
416 | ExemptFromBlockDownloadOfNonViewableFiles: boolean;
|
417 | Fields: Partial<IFieldInfo>[];
|
418 | FileSavePostProcessingEnabled: boolean;
|
419 | ForceCheckout: boolean;
|
420 | Forms: IFormInfo[];
|
421 | HasExternalDataSource: boolean;
|
422 | Hidden: boolean;
|
423 | Id: string;
|
424 | ImagePath: {
|
425 | DecodedUrl: string;
|
426 | };
|
427 | ImageUrl: string;
|
428 | InformationRightsManagementSettings: any[];
|
429 | IrmEnabled: boolean;
|
430 | IrmExpire: boolean;
|
431 | IrmReject: boolean;
|
432 | IsApplicationList: boolean;
|
433 | IsCatalog: boolean;
|
434 | IsPrivate: boolean;
|
435 | IsSiteAssetsLibrary: boolean;
|
436 | IsSystemList: boolean;
|
437 | ItemCount: number;
|
438 | LastItemDeletedDate: string;
|
439 | LastItemModifiedDate: string;
|
440 | LastItemUserModifiedDate: string;
|
441 | ListExperienceOptions: number;
|
442 | ListItemEntityTypeFullName: string;
|
443 | MajorVersionLimit: number;
|
444 | MajorWithMinorVersionsLimit: number;
|
445 | MultipleDataList: boolean;
|
446 | NoCrawl: boolean;
|
447 | OnQuickLaunch: boolean;
|
448 | ParentWebPath: {
|
449 | DecodedUrl: string;
|
450 | };
|
451 | ParentWebUrl: string;
|
452 | ParserDisabled: boolean;
|
453 | ReadSecurity: number;
|
454 | RootFolder: IFolderInfo;
|
455 | SchemaXml: string;
|
456 | ServerTemplateCanCreateFolders: boolean;
|
457 | TemplateFeatureId: string;
|
458 | Title: string;
|
459 | UserCustomActions: IUserCustomActionInfo[];
|
460 | ValidationFormula: string;
|
461 | ValidationMessage: string;
|
462 | Views: IViewInfo[];
|
463 | WorkflowAssociations: any[];
|
464 | WriteSecurity: number;
|
465 | }
|
466 | export interface IRenderListDataAsStreamResult {
|
467 | CurrentFolderSpItemUrl: string;
|
468 | FilterLink: string;
|
469 | FirstRow: number;
|
470 | FolderPermissions: string;
|
471 | ForceNoHierarchy: string;
|
472 | HierarchyHasIndention: string;
|
473 | LastRow: number;
|
474 | NextHref?: string;
|
475 | Row: any[];
|
476 | RowLimit: number;
|
477 | }
|
478 | export interface IListParentInfos {
|
479 | List: {
|
480 | Id: string;
|
481 | RootFolderServerRelativePath: IResourcePath;
|
482 | RootFolderServerRelativeUrl: string;
|
483 | RootFolderUniqueId: string;
|
484 | };
|
485 | ParentWeb: {
|
486 | Id: string;
|
487 | ServerRelativePath: IResourcePath;
|
488 | ServerRelativeUrl: string;
|
489 | Url: string;
|
490 | };
|
491 | }
|
492 |
|
\ | No newline at end of file |