UNPKG

2.03 kBTypeScriptView Raw
1import { ISiteGroups, ISiteGroup } from "./types.js";
2declare module "../webs/types" {
3 interface _Web {
4 readonly siteGroups: ISiteGroups;
5 readonly associatedOwnerGroup: ISiteGroup;
6 readonly associatedMemberGroup: ISiteGroup;
7 readonly associatedVisitorGroup: ISiteGroup;
8 createDefaultAssociatedGroups(groupNameSeed: string, siteOwner: string, copyRoleAssignments?: boolean, clearSubscopes?: boolean, siteOwner2?: string): Promise<void>;
9 }
10 interface IWeb {
11 /**
12 * Returns the site groups of this web
13 */
14 readonly siteGroups: ISiteGroups;
15 /**
16 * The web's owner group
17 */
18 readonly associatedOwnerGroup: ISiteGroup;
19 /**
20 * The web's member group
21 */
22 readonly associatedMemberGroup: ISiteGroup;
23 /**
24 * The web's visitor group
25 */
26 readonly associatedVisitorGroup: ISiteGroup;
27 /**
28 * Creates the default associated groups (Members, Owners, Visitors) and gives them the default permissions on the site.
29 * The target site must have unique permissions and no associated members / owners / visitors groups
30 *
31 * @param groupNameSeed The base group name. E.g. 'TestSite' would produce 'TestSite Members' etc.
32 * @param siteOwner The user login name to be added to the site Owners group. Default is the current user
33 * @param copyRoleAssignments Optional. If true the permissions are copied from the current parent scope
34 * @param clearSubscopes Optional. true to make all child securable objects inherit role assignments from the current object
35 * @param siteOwner2 Optional. The second user login name to be added to the site Owners group. Default is empty
36 */
37 createDefaultAssociatedGroups(groupNameSeed: string, siteOwner: string, copyRoleAssignments?: boolean, clearSubscopes?: boolean, siteOwner2?: string): Promise<void>;
38 }
39}
40//# sourceMappingURL=web.d.ts.map
\No newline at end of file