UNPKG

4.81 kBTypeScriptView Raw
1import { Shared } from "./IShared";
2import { SharePoint } from "./ISharePoint";
3import { Enums } from '../extensibility';
4export declare module Sites {
5 interface IBaseSiteTemplate {
6 id?: string;
7 title?: string;
8 description?: string;
9 }
10 interface ISiteTemplate {
11 id?: string;
12 title?: string;
13 description?: string;
14 createAsSiteCollection?: boolean;
15 lcid?: number;
16 storageMaximumLevel?: number;
17 location?: string;
18 icon?: ISiteTemplateIcon;
19 image?: string;
20 defaultTimeZone?: string;
21 useCurrentSiteLocation?: boolean;
22 baseTemplate?: string;
23 permissionLevel?: number;
24 userCanChangeLanguage?: boolean;
25 uniquePermission?: boolean;
26 siteCollectionFeatures?: Array<string>;
27 siteFeatures?: Array<string>;
28 isUserCreatedTemplate?: boolean;
29 userDefinedProperties?: ISiteTemplateUserDefinedProperties;
30 customFields?: Array<ISiteTemplateCustomField>;
31 createdBy?: string;
32 userCanChangePrivacy?: boolean;
33 privacy?: Enums.PrivacyType;
34 createAsOfficeGroup?: boolean;
35 }
36 interface IValidateSiteTemplateInfo {
37 isExistSiteTemplate: boolean;
38 isActivatedSiteDynamicProperties: boolean;
39 isHaveProperties: boolean;
40 }
41 interface IMigrateSiteInfo {
42 status: Enums.MigrateSitesStatus;
43 startedDate?: string;
44 sitesAlreadyMigrate: Array<string>;
45 sitesNeedMigration: Array<string>;
46 }
47 interface ISiteTemplateUserDefinedProperties {
48 approvers?: Array<SharePoint.IPeoplePickerPrincipal>;
49 displayTo?: Array<SharePoint.IPeoplePickerPrincipal>;
50 defaultAdministrator?: Array<SharePoint.IPeoplePickerPrincipal>;
51 defaultVisitors?: Array<SharePoint.IPeoplePickerPrincipal>;
52 templateGroup?: string;
53 migrationInfo?: IMigrateSiteInfo;
54 }
55 interface ISiteTemplateIcon {
56 iconType: Enums.SiteTemplateIconType;
57 fontValue?: string;
58 customValue?: string;
59 }
60 interface ISiteCreationValidation {
61 siteTemplate?: ISiteTemplate;
62 isFeatureDependencyValid: boolean;
63 isUserPermissionValid: boolean;
64 }
65 interface ISiteTemplateCustomField {
66 id?: string;
67 displayName?: string;
68 internalName?: string;
69 fieldType?: Enums.CustomFieldTypes;
70 isRequired?: boolean;
71 isMultiple?: boolean;
72 isFilterable?: boolean;
73 isViewable?: boolean;
74 termStoreId?: string;
75 termGroupId?: string;
76 termGroupName?: string;
77 termSetId?: string;
78 termSetName?: string;
79 value?: any;
80 fieldValidation?: ISiteTemplateCustomFieldValidation;
81 }
82 interface ISiteTemplateCustomFieldValidation {
83 duplicatedDisplayName?: boolean;
84 duplicatedInternalName?: boolean;
85 }
86 interface ISiteRequest {
87 id?: string;
88 siteTemplateId?: string;
89 title?: string;
90 description?: string;
91 location?: string;
92 url?: string;
93 keywords?: Array<string>;
94 lcid?: number;
95 timeZone?: string;
96 approvers?: string;
97 owners?: Array<string>;
98 members?: Array<string>;
99 readers?: Array<string>;
100 status?: Enums.SiteRequestStatus;
101 requestType?: Enums.SiteRequestType;
102 createdBy?: string;
103 createdAt?: Date;
104 processedBy?: string;
105 processedAt?: Date;
106 comment?: string;
107 createdByUser?: SharePoint.IUser;
108 urlValidateResult?: ISiteRequestUrlValidateResult;
109 transactionId?: string;
110 customFields?: Array<ISiteTemplateCustomField>;
111 privacy?: Enums.PrivacyType;
112 }
113 interface ISiteRequestResult {
114 siteRequestId: string;
115 transactionId: string;
116 }
117 interface ISiteRequestUrlValidateResult {
118 urlValidated?: boolean;
119 invalidUrl?: boolean;
120 existedWeb?: Shared.IPortalWeb;
121 validateUrlInProcess?: boolean;
122 validateUrlTimeout?: any;
123 }
124 interface ISiteProvisioningResult {
125 isSiteCreated: boolean;
126 welcomePageUrl: string;
127 }
128 interface IOfficeGroupRequest {
129 displayName?: string;
130 alias?: string;
131 isPublic?: boolean;
132 optionalParams?: IOptionalParams;
133 }
134 interface IOptionalParams {
135 Description?: string;
136 Owners?: Array<string>;
137 }
138 interface IOfficeGroupResponse {
139 documentsUrl?: any;
140 errorMessage?: any;
141 groupId?: string;
142 siteStatus?: number;
143 siteUrl?: string;
144 }
145}