UNPKG

1.72 kBTypeScriptView Raw
1import { ILists, IList } from "./types.js";
2import { ISPCollection } from "../spqueryable.js";
3declare module "../webs/types" {
4 interface _Web {
5 readonly lists: ILists;
6 readonly siteUserInfoList: IList;
7 readonly defaultDocumentLibrary: IList;
8 readonly customListTemplates: ISPCollection;
9 getList(listRelativeUrl: string): IList;
10 getCatalog(type: number): Promise<IList>;
11 }
12 interface IWeb {
13 /**
14 * Gets the collection of all lists that are contained in the Web site
15 */
16 readonly lists: ILists;
17 /**
18 * Gets the UserInfo list of the site collection that contains the Web site
19 */
20 readonly siteUserInfoList: IList;
21 /**
22 * Get a reference the default documents library of a web
23 */
24 readonly defaultDocumentLibrary: IList;
25 /**
26 * Gets the collection of all list definitions and list templates that are available
27 */
28 readonly customListTemplates: ISPCollection;
29 /**
30 * Gets a list by server relative url (list's root folder)
31 *
32 * @param listRelativeUrl The server relative path to the list's root folder (including /sites/ if applicable)
33 */
34 getList(listRelativeUrl: string): IList;
35 /**
36 * Returns the list gallery on the site
37 *
38 * @param type The gallery type - WebTemplateCatalog = 111, WebPartCatalog = 113 ListTemplateCatalog = 114,
39 * MasterPageCatalog = 116, SolutionCatalog = 121, ThemeCatalog = 123, DesignCatalog = 124, AppDataCatalog = 125
40 */
41 getCatalog(type: number): Promise<IList>;
42 }
43}
44//# sourceMappingURL=web.d.ts.map
\No newline at end of file