/
gd-sprest.d.ts
13335 lines (13168 loc) · 513 KB
/
gd-sprest.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Generated by dts-bundle v0.7.3
declare module 'gd-sprest' {
/***************************************************************************************************
MIT License
Copyright (c) 2016 Dattabase, LLC.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
***************************************************************************************************/
import * as Helper from "gd-sprest/helper";
import { SPTypes } from "gd-sprest/mapper";
import * as Types from "gd-sprest/types";
export * from "gd-sprest/lib";
export * from "gd-sprest/rest";
export { Helper, SPTypes, Types };
}
declare module 'gd-sprest/helper' {
export * from "gd-sprest/helper/app";
export * from "gd-sprest/helper/dependencies";
export * from "gd-sprest/helper/executor";
export * from "gd-sprest/helper/fieldSchemaXML";
export * from "gd-sprest/helper/jslink";
export * from "gd-sprest/helper/listForm";
export * from "gd-sprest/helper/listFormField";
export * from "gd-sprest/helper/loader";
export * from "gd-sprest/helper/methods";
export * from "gd-sprest/helper/ribbonLink";
export * from "gd-sprest/helper/sbLink";
export * from "gd-sprest/helper/spCfg";
export * from "gd-sprest/helper/taxonomy";
export * from "gd-sprest/helper/webpart";
import * as SP from "gd-sprest/helper/sp";
export { SP };
import * as Types from "gd-sprest/helper/types";
export { Types };
}
declare module 'gd-sprest/mapper' {
import * as Mapper from "gd-sprest/mapper/mapper";
import * as SPTypes from "gd-sprest/mapper/sptypes";
import * as Types from "gd-sprest/mapper/types";
export { Mapper, SPTypes, Types };
}
declare module 'gd-sprest/types' {
import { Types as Helper } from "gd-sprest/helper";
import { Types as SP } from "gd-sprest/mapper";
import { Types as Util } from "gd-sprest/utils";
export { Helper, SP, Util };
}
declare module 'gd-sprest/lib' {
export * from "gd-sprest/lib/contextInfo";
export * from "gd-sprest/lib/graph";
export * from "gd-sprest/lib/list";
export * from "gd-sprest/lib/navigation";
export * from "gd-sprest/lib/peopleManager";
export * from "gd-sprest/lib/peoplePicker";
export * from "gd-sprest/lib/profileLoader";
export * from "gd-sprest/lib/search";
export * from "gd-sprest/lib/site";
export * from "gd-sprest/lib/socialFeed";
export * from "gd-sprest/lib/userProfile";
export * from "gd-sprest/lib/utility";
export * from "gd-sprest/lib/web";
import * as Types from "gd-sprest/lib/types";
export { Types };
}
declare module 'gd-sprest/rest' {
import * as Helper from "gd-sprest/helper";
import * as Lib from "gd-sprest/lib";
import * as Mapper from "gd-sprest/mapper";
import * as Util from "gd-sprest/utils";
/**
* Helper
*/
export interface IHelper {
/**
* Helper classes for the app web
*/
App: Helper.Types.IApp;
/**
* Helper class to load the required SP scripts
*/
Dependencies: Helper.Types.IDependencies;
/**
* Method to create a document set item.
*/
createDocSet: (name: string, listName: string, webUrl?: string) => PromiseLike<Mapper.Types.IListItemResult>;
/**
* Executor
*/
Executor<T = any>(methodParams: Array<T>, method: (param: T) => PromiseLike<any> | void, onExecuted?: (...args: any[]) => PromiseLike<any> | void): any;
/**
* Helper class for generating a field schema xml
*/
FieldSchemaXML: (fieldInfo: Helper.Types.IFieldInfo) => PromiseLike<string>;
/**
* Helper class for implementing JSLink solutions
*/
JSLink: Helper.Types.IJSLink;
/**
* Helper class for implementing custom list forms
*/
ListForm: Helper.Types.IListForm;
/**
* Helper class for implementing custom list forms
*/
ListFormField: Helper.Types.IListFormField;
/**
* Helper class for waiting until the core SP scripts are loaded
*/
Loader: Helper.Types.ILoader;
/**
* Helper method to convert a json string to a base object
* This will require you to use the stringify method of the base object.
*/
parse<T = Util.Types.IBase>(jsonString: string): T;
/**
* Helper method to execute an XMLHttpRequest
*/
request(props: Helper.Types.IRequest): PromiseLike<any>;
/**
* Helper class for adding links to the top ribbon bar
*/
RibbonLink: (props: Helper.Types.ILinkInfo) => HTMLAnchorElement;
/**
* SharePoint Core Library Reference
*/
SP: {
/** Modal Dialog */
ModalDialog: Helper.Types.IModalDialog;
/** Notify */
Notify: Helper.Types.INotify;
/** Status */
Status: Helper.Types.IStatus;
};
/**
* The field configuration types
*/
SPCfgFieldType: Helper.Types.ISPCfgFieldType;
/**
* The configuration types
*/
SPCfgType: Helper.Types.ISPCfgType;
/**
* Helper class for automating SharePoint assets
*/
SPConfig: (cfg: Helper.Types.ISPConfigProps, webUrl?: string) => Helper.Types.ISPConfig;
/**
* Helper class for adding links to the suite bar
*/
SuiteBarLink: (props: Helper.Types.ILinkInfo) => HTMLAnchorElement;
/**
* Helper class for getting information from the taxonomy term store
*/
Taxonomy: Helper.Types.ITaxonomy;
/**
* Helper class for creating modern webparts in SharePoint 2013+ environments
*/
WebPart: Helper.Types.IWebPart;
}
/**
* SharePoint REST Library
*/
export interface IREST {
/**
* The version number of the library.
*/
__ver: number;
/**
* Use this api to get the app context information of a site.
*/
AppContext: (siteUrl: string) => Util.Types.IBase;
/**
* A reference to the _spPageContextInfo global variable.
*/
ContextInfo: Lib.Types.IContextInformation;
/**
* False by default.
*/
DefaultRequestToHostFl: boolean;
/**
* Use this api to interact with the Graph API. (Still In Development)
*/
Graph: Lib.Types.IGraph;
/**
* Helper methods.
*/
Helper: IHelper;
/**
* Use this api to interact with SharePoint lists and libraries.
*/
List: Lib.Types.IList;
/**
* Use this api to get the list name by its entity name.
* @param entityTypeName - The entity type name of the list.
* @param callback - The method to be executed after the request completes.
*/
ListByEntityName(entityTypeName: string, callback: (IList: any) => void, targetInfo?: any): Util.Types.IBase<Mapper.Types.IList, Mapper.Types.IListResult, Mapper.Types.IListQueryResult>;
/**
* Use this api to get the list data.
* @param listFullUrl - The absolute url of the list.
* @param parameters - The optional list data parameters.
*/
ListDataAsStream: (listFullUrl: string, parameters?: Mapper.Types.IListDataParameters) => Util.Types.IBase<Mapper.Types.IListDataStream>;
/**
* Use this api to interact with SharePoint navigation.
*/
Navigation: Lib.Types.INavigation;
/**
* Use this api to interact with SharePoint user profiles.
* @param targetInfo - (Optional) The target information.
*/
PeopleManager: Lib.Types.IPeopleManager;
/**
* Use this api to search for users.
* @param settings - The search settings.
*/
PeoplePicker: Lib.Types.IPeoplePicker;
/**
* Use this api to interact with the user profile loader.
* @param targetInfo - (Optional) The target information.
*/
ProfileLoader: Lib.Types.IProfileLoader;
/**
* Use this api to get a remote web.
* @param requestUrl - The absolute url of the remote web.
*/
RemoteWeb: (requestUrl?: string) => Util.Types.IBase<Mapper.Types.IWebRemote>;
/**
* Use this api to interact with the SharePoint search service.
* @param url - The optional url to execute the search against.
* @param settings - The search settings.
*/
Search: Lib.Types.ISearch;
/**
* Use this api to interact with a SharePoint site collection.
*/
Site: Lib.Types.ISite;
/**
* Use this api to see if a site collection exists.
* @param url - The absolute url of the site collection.
*/
SiteExists: (url: string) => Util.Types.IBase<Mapper.Types.ISiteExists>;
/**
* Use this api to get the url of a site, by its id.
* @param id - The site id.
*/
SiteUrl: (id: string) => Util.Types.IBase<Mapper.Types.ISiteUrl>;
/**
* Use this api to interact with the current user's social profile.
*/
SocialFeed: Lib.Types.ISocialFeed;
/**
* The SharePoint enumerator types.
*/
SPTypes: any;
/**
* Use this api to interact with the current user's profile.
*/
UserProfile: Lib.Types.IUserProfile;
/**
* Use this api to interact with the available utility methods.
*/
Utility: Lib.Types.IUtility;
/**
* Use this api to interact with a SharePoint web.
*/
Web: Lib.Types.IWeb;
}
/**
* SharePoint REST Library
*/
export const $REST: IREST;
}
declare module 'gd-sprest/helper/app' {
import { IApp } from "gd-sprest/helper/types";
/**
* App Helper Methods
* Helper methods designed to be run from the app web.
*/
export const App: IApp;
}
declare module 'gd-sprest/helper/dependencies' {
import { IDependencies } from "gd-sprest/helper/types";
export const Dependencies: IDependencies;
}
declare module 'gd-sprest/helper/executor' {
/**
* Executor
* @param methodParams - An array of parameters to execute in order synchronously.
* @param method - The method to execute for each method parameter provided.
* @param onExecuted - An optional event executed after the method completes. If a promise is returned, the executor will wait until it's resolved.
*/
export function Executor<T = any>(methodParams: Array<T>, method: (param: T) => PromiseLike<any> | void, onExecuted?: (...args: any[]) => PromiseLike<any> | void): Promise<{}>;
}
declare module 'gd-sprest/helper/fieldSchemaXML' {
import { IFieldInfo } from "gd-sprest/helper/types";
/**
* Field Schema XML
* Helper class for generating the field schema xml
*/
export const FieldSchemaXML: (fieldInfo: IFieldInfo) => PromiseLike<string>;
}
declare module 'gd-sprest/helper/jslink' {
import { IJSLink } from "gd-sprest/helper/types";
/**
* JSLink Helper Methods
*/
export const JSLink: IJSLink;
}
declare module 'gd-sprest/helper/listForm' {
import { IListForm } from "gd-sprest/helper/types";
/**
* List Form
*/
export const ListForm: IListForm;
}
declare module 'gd-sprest/helper/listFormField' {
import { IListFormField } from "gd-sprest/helper/types";
/**
* List Form Field
*/
export const ListFormField: IListFormField;
}
declare module 'gd-sprest/helper/loader' {
import { ILoader } from "gd-sprest/helper/types";
/**
* Loader
*/
export const Loader: ILoader;
}
declare module 'gd-sprest/helper/methods' {
import { IListItemResult } from "gd-sprest/mapper/types";
import { Base } from "gd-sprest/utils";
import { IRequest } from "gd-sprest/helper/types";
/**
* Creates a document set item.
* @param name - The name of the document set folder to create.
* @param listName - The name of the document set library.
* @param webUrl - The url of the web containing the document set library.
*/
export const createDocSet: (name: string, listName: string, webUrl?: string) => PromiseLike<IListItemResult>;
/**
* Convert a JSON string to a base object
*/
export const parse: <T = Base<any, any, any>>(jsonString: string) => T;
/**
* XML HTTP Request
*/
export const request: (props: IRequest) => PromiseLike<any>;
}
declare module 'gd-sprest/helper/ribbonLink' {
import { ILinkInfo } from "gd-sprest/helper/types";
/**
* Ribbon Link
*/
export const RibbonLink: (props: ILinkInfo) => HTMLAnchorElement;
}
declare module 'gd-sprest/helper/sbLink' {
import { ILinkInfo } from "gd-sprest/helper/types";
/**
* Suite Bar Link
*/
export const SuiteBarLink: (props: ILinkInfo) => HTMLAnchorElement;
}
declare module 'gd-sprest/helper/spCfg' {
export * from "gd-sprest/helper/spCfgTypes";
import { Types } from "gd-sprest/";
/**
* SharePoint Configuration
*/
export const SPConfig: (cfg: Types.Helper.ISPConfigProps, webUrl?: string) => Types.Helper.ISPConfig;
}
declare module 'gd-sprest/helper/taxonomy' {
import * as TaxonomyTypes from "gd-sprest/helper/types";
/**
* Taxonomy Helper Class
*/
export const Taxonomy: TaxonomyTypes.ITaxonomy;
}
declare module 'gd-sprest/helper/webpart' {
import * as WebPartTypes from "gd-sprest/helper/types";
export const WebPart: WebPartTypes.IWebPart;
}
declare module 'gd-sprest/helper/sp' {
import { IModalDialog, INotify, IStatus } from "gd-sprest/helper/types";
/**
* Modal Dialog
*/
export const ModalDialog: IModalDialog;
/**
* Notification
*/
export const Notify: INotify;
/**
* Status
*/
export const Status: IStatus;
}
declare module 'gd-sprest/helper/types' {
export * from "gd-sprest/helper/types/app";
export * from "gd-sprest/helper/types/dependencies";
export * from "gd-sprest/helper/types/fieldSchemaXML";
export * from "gd-sprest/helper/types/jslink";
export * from "gd-sprest/helper/types/linkInfo";
export * from "gd-sprest/helper/types/listForm";
export * from "gd-sprest/helper/types/listFormField";
export * from "gd-sprest/helper/types/loader";
export * from "gd-sprest/helper/types/methods";
export * from "gd-sprest/helper/types/sp";
export * from "gd-sprest/helper/types/spCfg";
export * from "gd-sprest/helper/types/spCfgTypes";
export * from "gd-sprest/helper/types/taxonomy";
export * from "gd-sprest/helper/types/webpart";
}
declare module 'gd-sprest/mapper/mapper' {
export * from "gd-sprest/mapper/audit";
export * from "gd-sprest/mapper/eventReceiver";
export * from "gd-sprest/mapper/file";
export * from "gd-sprest/mapper/graph";
export * from "gd-sprest/mapper/list";
export * from "gd-sprest/mapper/navigation";
export * from "gd-sprest/mapper/propertyValues";
export * from "gd-sprest/mapper/search";
export * from "gd-sprest/mapper/security";
export * from "gd-sprest/mapper/site";
export * from "gd-sprest/mapper/social";
export * from "gd-sprest/mapper/user";
export * from "gd-sprest/mapper/userCustomAction";
}
declare module 'gd-sprest/mapper/sptypes' {
import { SPTypes } from "gd-sprest/mapper/types";
/**
* Base Permission Types
*/
export const BasePermissionTypes: SPTypes.IBasePermissionType;
/**
* Calendar Types
*/
export const CalendarTypes: SPTypes.ICalendarType;
/**
* Check Out Types
*/
export const CheckOutType: SPTypes.ICheckOutType;
/**
* Choice Format Types
*/
export const ChoiceFormatType: SPTypes.IChoiceFormatType;
/**
* Client Template Utility
*/
export const ClientTemplatesUtility: SPTypes.IClientTemplateUtility;
/**
* Control Modes
*/
export const ControlMode: SPTypes.IControlMode;
/**
* Date Format
*/
export const DateFormat: SPTypes.IDateFormat;
/**
* Draft Visibility Types
*/
export const DraftVisibilityType: SPTypes.IDraftVisibilityType;
/**
* Event Receiver Synchronization Types
*/
export const EventReceiverSynchronizationType: SPTypes.IEventReceiverSynchronizationType;
/**
* Event Receiver Types
*/
export const EventReceiverType: SPTypes.IEventReceiverType;
/**
* Field Note Types
*/
export const FieldNoteType: SPTypes.IFieldNoteType;
/**
* Field Number Type
*/
export const FieldNumberType: SPTypes.IFieldNumberType;
/**
* Field Result Types
*/
export const FieldResultType: SPTypes.IFieldResultType;
/**
* Field Types
*/
export const FieldType: SPTypes.IFieldType;
/**
* Field User Selection Types
*/
export const FieldUserSelectionType: SPTypes.IFieldUserSelectionType;
/**
* File Template Types
*/
export const FileTemplateType: SPTypes.IFileTemplateType;
/**
* Friendly Date Format
*/
export const FriendlyDateFormat: SPTypes.IFriendlyDateFormat;
/**
* List Template Types
*/
export const ListTemplateType: SPTypes.IListTemplateType;
/**
* Locale LCID Types
*/
export const LocaleLCIDType: SPTypes.ILocaleLCIDType;
/**
* Node Types - Need to get this info. Documentation not found online. Ref the MS Publishing DLL and decompile to find the type info.
*/
export type NodeType = {
/** Specifies no node SPTypes.I */
None: 0;
/** Specifies any type of SPWeb site. */
Area: 0;
/** Specifies a List item in the Pages list. */
Page: 0;
/** Specifies a Microsoft SharePoint Foundation list (SPList). */
List: 0;
/** Specifies a Microsoft SharePoint Foundation list item (SPListItem). */
ListItem: 0;
/** Specifies a CMS Page Layout. */
PageLayout: 0;
/** Specifies a navigation heading. */
Heading: 0;
/** Specifies an authored link that references a page. */
AuthoredLinkToPage: 0;
/** Specifies an authored link that references a Web site or area. */
AuthoredLinkToWeb: 0;
/** Specifies a generic authored link. */
AuthoredLinkPlain: 0;
/** Specifies a custom node type that may be useful for extensibility purposes. */
Custom: 0;
/** Represents an error specific to node SPTypes.I */
Error: 0;
/** Specifies any type of authored link. */
AuthoredLink: 0;
/** Specifies a combination of Area, Page, Heading and AuthoredLink. Navigation uses this value to determine which node types to return by default. */
Default: 0;
/** Specifies all node types, including Area, Page, List, ListItem, PageLayout, Heading, AuthoredLink, and Custom. */
All: 0;
};
/**
* Page Types
*/
export const PageType: SPTypes.IPageType;
/**
* Personal Site Capabilities
*/
export const PersonalSiteCapabilities: SPTypes.IPersonalSiteCapabilities;
/**
* Principal Sources
*/
export const PrincipalSources: SPTypes.IPrincipalSources;
/**
* Principal Types
*/
export const PrincipalTypes: SPTypes.IPrincipalTypes;
/**
* Relationship Delete Behavior Types
*/
export const RelationshipDeleteBehaviorType: SPTypes.IRelationshipDeleteBehaviorType;
/**
* Render List Data Options
*/
export const RenderListDataOptions: {
None: number;
ContextInfo: number;
ListData: number;
ListSchema: number;
MenuView: number;
ListContentType: number;
FileSystemItemId: number;
ClientFormSchema: number;
QuickLaunch: number;
Spotlight: number;
Visualization: number;
ViewMetadata: number;
DisableAutoHyperlink: number;
EnableMediaTAUrls: number;
ParentInfo: number;
PageContextInfo: number;
ClientSideComponentManifest: number;
};
/**
* Reordering Rule Match Types
*/
export const ReorderingRuleMatchType: SPTypes.IReorderingRuleMatchType;
/**
* Role Types
*/
export const RoleType: SPTypes.IRoleType;
/**
* Status Pri Color
*/
export const StatusPriColor: SPTypes.IStatusPriColor;
/**
* URL Format Types
*/
export const UrlFormatType: SPTypes.IUrlFormatType;
/**
* URL Zones
*/
export const URLZones: SPTypes.IURLZones;
/**
* User Custom Action Registration Types
*/
export const UserCustomActionRegistrationType: SPTypes.IUserCustomActionRegistrationType;
/**
* View Types
*/
export const ViewType: SPTypes.IViewType;
/**
* Web Template Types
*/
export const WebTemplateType: {
AcademicLibrary: string;
App: string;
AppCatalog: string;
BasicSearch: string;
Blog: string;
BusinessIntelligenceCenter: string;
CentralAdmin: string;
Community: string;
CommunityPortal: string;
Dev: string;
DocumentCenter: string;
eDiscoveryCenter: string;
EnterpriseSearch: string;
EnterpriseWiki: string;
Global: string;
GroupWorkSite: string;
Meetings: string;
MeetingWorkspace: string;
PerformancePoint: string;
ProductCatalog: string;
Profiles: string;
ProjectSite: string;
Publishing: string;
PublishingSite: string;
RecordsCenter: string;
SharedServicesAdminSite: string;
Site: string;
TeamCollaborationSite: string;
TenantAdmin: string;
Wiki: string;
};
}
declare module 'gd-sprest/mapper/types' {
export * from "gd-sprest/mapper/types/attachment";
export * from "gd-sprest/mapper/types/attachments";
export * from "gd-sprest/mapper/types/audit";
import * as ComplexTypes from "gd-sprest/mapper/types/complexTypes";
export * from "gd-sprest/mapper/types/contentType";
export * from "gd-sprest/mapper/types/contentTypes";
export * from "gd-sprest/mapper/types/eventReceiver";
export * from "gd-sprest/mapper/types/eventReceivers";
export * from "gd-sprest/mapper/types/features";
export * from "gd-sprest/mapper/types/field";
export * from "gd-sprest/mapper/types/fieldLink";
export * from "gd-sprest/mapper/types/fieldLinks";
export * from "gd-sprest/mapper/types/fields";
export * from "gd-sprest/mapper/types/file";
export * from "gd-sprest/mapper/types/files";
export * from "gd-sprest/mapper/types/fileVersion";
export * from "gd-sprest/mapper/types/fileVersions";
export * from "gd-sprest/mapper/types/folder";
export * from "gd-sprest/mapper/types/folders";
export * from "gd-sprest/mapper/types/graph";
export * from "gd-sprest/mapper/types/group";
export * from "gd-sprest/mapper/types/groups";
export * from "gd-sprest/mapper/types/items";
export * from "gd-sprest/mapper/types/limitedWebPartManager";
export * from "gd-sprest/mapper/types/list";
export * from "gd-sprest/mapper/types/listItem";
export * from "gd-sprest/mapper/types/lists";
export * from "gd-sprest/mapper/types/navigation";
export * from "gd-sprest/mapper/types/peopleManager";
export * from "gd-sprest/mapper/types/peoplePicker";
export * from "gd-sprest/mapper/types/profileLoader";
export * from "gd-sprest/mapper/types/propertyValues";
import * as Results from "gd-sprest/mapper/types/results";
export * from "gd-sprest/mapper/types/roleAssignment";
export * from "gd-sprest/mapper/types/roleAssignments";
export * from "gd-sprest/mapper/types/roleDefinition";
export * from "gd-sprest/mapper/types/roleDefinitions";
export * from "gd-sprest/mapper/types/search";
export * from "gd-sprest/mapper/types/site";
export * from "gd-sprest/mapper/types/socialFeed";
import * as SPTypes from "gd-sprest/mapper/types/sptypes";
export * from "gd-sprest/mapper/types/tenantApp";
export * from "gd-sprest/mapper/types/tenantAppCatalog";
export * from "gd-sprest/mapper/types/tenantApps";
export * from "gd-sprest/mapper/types/types";
export * from "gd-sprest/mapper/types/user";
export * from "gd-sprest/mapper/types/userCustomAction";
export * from "gd-sprest/mapper/types/userCustomActions";
export * from "gd-sprest/mapper/types/userProfile";
export * from "gd-sprest/mapper/types/users";
export * from "gd-sprest/mapper/types/utility";
export * from "gd-sprest/mapper/types/version";
export * from "gd-sprest/mapper/types/versions";
export * from "gd-sprest/mapper/types/view";
export * from "gd-sprest/mapper/types/viewFieldCollection";
export * from "gd-sprest/mapper/types/views";
export * from "gd-sprest/mapper/types/web";
export * from "gd-sprest/mapper/types/webs";
export { ComplexTypes, Results, SPTypes };
}
declare module 'gd-sprest/utils' {
export * from "gd-sprest/utils/requestType";
export * from "gd-sprest/utils/baseHelper";
export * from "gd-sprest/utils/baseRequest";
export * from "gd-sprest/utils/baseExecution";
export * from "gd-sprest/utils/base";
export * from "gd-sprest/utils/batch";
export * from "gd-sprest/utils/methodInfo";
export * from "gd-sprest/utils/oData";
export * from "gd-sprest/utils/targetInfo";
export * from "gd-sprest/utils/xhrRequest";
import * as Types from "gd-sprest/utils/types";
export { Types };
}
declare module 'gd-sprest/lib/contextInfo' {
import { IContextInformation } from "gd-sprest/lib/types";
export const ContextInfo: IContextInformation;
}
declare module 'gd-sprest/lib/graph' {
import { IGraph } from "gd-sprest/lib/types";
/**
* Graph
*/
export const Graph: IGraph;
}
declare module 'gd-sprest/lib/list' {
import { IList } from "gd-sprest/lib/types";
/**
* List
*/
export const List: IList;
}
declare module 'gd-sprest/lib/navigation' {
import { INavigation } from "gd-sprest/lib/types";
/**
* Navigation
*/
export const Navigation: INavigation;
}
declare module 'gd-sprest/lib/peopleManager' {
import { IPeopleManager } from "gd-sprest/lib/types";
/**
* People Manager
*/
export const PeopleManager: IPeopleManager;
}
declare module 'gd-sprest/lib/peoplePicker' {
import { IPeoplePicker } from "gd-sprest/lib/types";
/**
* People Picker
*/
export const PeoplePicker: IPeoplePicker;
}
declare module 'gd-sprest/lib/profileLoader' {
import { IProfileLoader } from "gd-sprest/lib/types";
/**
* Profile Loader
*/
export const ProfileLoader: IProfileLoader;
}
declare module 'gd-sprest/lib/search' {
import { ISearch } from "gd-sprest/lib/types";
/**
* Search
*/
export const Search: ISearch;
}
declare module 'gd-sprest/lib/site' {
import { ISite } from "gd-sprest/lib/types";
/**
* Site
*/
export const Site: ISite;
}
declare module 'gd-sprest/lib/socialFeed' {
import { ISocialFeed } from "gd-sprest/lib/types";
/**
* Social Feed
*/
export const SocialFeed: ISocialFeed;
}
declare module 'gd-sprest/lib/userProfile' {
import { IUserProfile } from "gd-sprest/lib/types";
/**
* User Profile
*/
export const UserProfile: IUserProfile;
}
declare module 'gd-sprest/lib/utility' {
import { IUtility } from "gd-sprest/lib/types";
/**
* Utility
*/
export const Utility: IUtility;
}
declare module 'gd-sprest/lib/web' {
import { IWeb } from "gd-sprest/lib/types";
export const Web: IWeb;
}
declare module 'gd-sprest/lib/types' {
export * from "gd-sprest/lib/types/contextInfo";
export * from "gd-sprest/lib/types/graph";
export * from "gd-sprest/lib/types/list";
export * from "gd-sprest/lib/types/navigation";
export * from "gd-sprest/lib/types/peopleManager";
export * from "gd-sprest/lib/types/peoplePicker";
export * from "gd-sprest/lib/types/profileLoader";
export * from "gd-sprest/lib/types/search";
export * from "gd-sprest/lib/types/site";
export * from "gd-sprest/lib/types/socialFeed";
export * from "gd-sprest/lib/types/userProfile";
export * from "gd-sprest/lib/types/utility";
export * from "gd-sprest/lib/types/web";
}
declare module 'gd-sprest/helper/spCfgTypes' {
import { ISPCfgFieldType, ISPCfgType } from "gd-sprest/helper/types";
/**
* SharePoint Configuration Field Types
*/
export const SPCfgFieldType: ISPCfgFieldType;
/**
* SharePoint Configuration Types
* The value determines the order to install the object type.
*/
export const SPCfgType: ISPCfgType;
}
declare module 'gd-sprest/' {
/***************************************************************************************************
MIT License
Copyright (c) 2016 Dattabase, LLC.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
***************************************************************************************************/
import * as Helper from "gd-sprest/helper";
import { SPTypes } from "gd-sprest/mapper";
import * as Types from "gd-sprest/types";
export * from "gd-sprest/lib";
export * from "gd-sprest/rest";
export { Helper, SPTypes, Types };
}
declare module 'gd-sprest/helper/types/app' {
import { Types } from "gd-sprest/";
/**
* App Helper Methods
*/
export interface IApp {
/**
* Method to copy a file from the app web to the host web.
* @param srcFileUrl - The source file url, relative to the app web.
* @param dstFolder - The destination folder.
* @param overwriteFl - Flag to overwrite the file in the destination folder, if it already exists. This value is falst by default.
* @param rootWebFl - Flag to target the root web of the site collection, otherwise the host web.
*/
copyFileToHostWeb(srcFileUrl: string, dstFolder: Types.SP.IFolderResult, overwriteFl?: boolean, rootWebFl?: boolean): PromiseLike<{
file: Types.SP.IFileResult;
folder: Types.SP.IFolderResult;
}>;
/**
* Method to copy a file from the app web to the host web.
* @param srcFileUrl - The source file url, relative to the app web.
* @param dstFolderUrl - The destination folder url, relative to the host web.
* @param overwriteFl - Flag to overwrite the file in the destination folder, if it already exists. This value is falst by default.
* @param rootWebFl - Flag to target the root web of the site collection, otherwise the host web.
*/
copyFileToHostWeb(srcFileUrl: string, dstFolderUrl: string, overwriteFl?: boolean, rootWebFl?: boolean): PromiseLike<{
file: Types.SP.IFileResult;
folder: Types.SP.IFolderResult;
}>;
/**
* Method to copy a file from the app web to the host web
* @param fileUrls - An array of source file urls, relative to the app web.
* @param folderUrls - An array of destination folder urls, relative to the host web.
* @param rootWebFl - Flag to target the root web of the site collection, otherwise the host web.
*/
copyFilesToHostWeb(fileUrls: Array<string>, folderUrls: Array<string>, overwriteFl?: boolean, rootWebFl?: boolean): PromiseLike<{
files: Array<Types.SP.IFileResult>;
folders: Array<Types.SP.IFolderResult>;
}>;
/**
* Method to create sub-folders.
* @param folder - The app web relative url to the source file.
* @param subFolderUrl - The host web relative url of the destination folder.
*/
createSubFolders(folder: Types.SP.IFolder, subFolderUrl: string): PromiseLike<Types.SP.IFolderResult>;
/**
* Method to get the file content.
* @param web - The web containing the files.
* @param fileUrls - An array of file urls, relative to the web.
* @param createFl - Flag to create the folder, if it doesn't exist.
*/
getFolder(web: Types.SP.IWeb | Types.SP.IWebResult, folderUrl: string, createFl?: boolean): PromiseLike<Types.SP.IFolderResult>;
/**
* Method to remove empty folders
* @param web - The web containing the files.
* @param folderUrls - An array of folder urls, relative to the web.
*/
removeEmptyFolders(web: Types.SP.IWebResult, folderUrls: Array<string>): PromiseLike<void>;
/**
* Method to remove files from a web.
* @param web - The web containing the files.
* @param fileUrl - The file url, relative to the web.
*/
removeFile(web: Types.SP.IWebResult, fileUrl: string): PromiseLike<void>;
/**
* Method to remove files from a web.
* @param web - The web containing the files.
* @param fileUrls - An array of file urls, relative to the web.
*/
removeFiles(web: Types.SP.IWebResult, fileUrls: Array<string>): PromiseLike<void>;
}
}
declare module 'gd-sprest/helper/types/dependencies' {
/**
* Dependencies