-
Notifications
You must be signed in to change notification settings - Fork 16
/
spsite.yml
149 lines (149 loc) · 5.24 KB
/
spsite.yml
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
### YamlMime:TSType
name: SPSite
uid: '@microsoft/sp-page-context!SPSite:class'
package: '@microsoft/sp-page-context!'
fullName: SPSite
summary: >-
This class is primarily used with the `PageContext` class. It provides contextual information for the SharePoint site
collection ("SPSite") that hosts the page.
remarks: >-
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or
create subclasses that extend the `SPSite` class.
isPreview: false
isDeprecated: false
type: class
properties:
- name: absoluteUrl
uid: '@microsoft/sp-page-context!SPSite#absoluteUrl:member'
package: '@microsoft/sp-page-context!'
fullName: absoluteUrl
summary: Returns the absolute URL for this SPSite.
remarks: 'Example: "https://example.com/sites/PubSite"'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly absoluteUrl: string;'
return:
type: string
- name: cdnPrefix
uid: '@microsoft/sp-page-context!SPSite#cdnPrefix:member'
package: '@microsoft/sp-page-context!'
fullName: cdnPrefix
summary: Returns the prefix of the application's specified cdn or an empty string if there isn't one.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'readonly cdnPrefix: string;'
return:
type: string
- name: classification
uid: '@microsoft/sp-page-context!SPSite#classification:member'
package: '@microsoft/sp-page-context!'
fullName: classification
summary: Returns the classification of the site.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'readonly classification: string;'
return:
type: string
- name: correlationId
uid: '@microsoft/sp-page-context!SPSite#correlationId:member'
package: '@microsoft/sp-page-context!'
fullName: correlationId
summary: Returns the correlation id to the current server request.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'readonly correlationId: Guid;'
return:
type: '<xref uid="@microsoft/sp-core-library!Guid:class" />'
- name: group
uid: '@microsoft/sp-page-context!SPSite#group:member'
package: '@microsoft/sp-page-context!'
fullName: group
summary: >-
Contextual information about the O365 Group associated with this site. If there is no O365Group associated with
the current site, this property will be undefined.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'readonly group: O365GroupAssociation | undefined;'
return:
type: '<xref uid="@microsoft/sp-page-context!O365GroupAssociation:class" /> | undefined'
- name: id
uid: '@microsoft/sp-page-context!SPSite#id:member'
package: '@microsoft/sp-page-context!'
fullName: id
summary: The GUID that identifies the SPSite on the server.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'readonly id: Guid;'
return:
type: '<xref uid="@microsoft/sp-core-library!Guid:class" />'
- name: isNoScriptEnabled
uid: '@microsoft/sp-page-context!SPSite#isNoScriptEnabled:member'
package: '@microsoft/sp-page-context!'
fullName: isNoScriptEnabled
summary: Returns true if isNoScript has been enabled on the SPSite.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'readonly isNoScriptEnabled: boolean;'
return:
type: boolean
- name: recycleBinItemCount
uid: '@microsoft/sp-page-context!SPSite#recycleBinItemCount:member'
package: '@microsoft/sp-page-context!'
fullName: recycleBinItemCount
summary: The amount of items in the recycle bin.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'readonly recycleBinItemCount: number;'
return:
type: number
- name: serverRelativeUrl
uid: '@microsoft/sp-page-context!SPSite#serverRelativeUrl:member'
package: '@microsoft/sp-page-context!'
fullName: serverRelativeUrl
summary: Returns the server-relative URL for this SPSite.
remarks: 'Example: "/sites/PubSite"'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly serverRelativeUrl: string;'
return:
type: string
- name: serverRequestPath
uid: '@microsoft/sp-page-context!SPSite#serverRequestPath:member'
package: '@microsoft/sp-page-context!'
fullName: serverRequestPath
summary: Returns serverRelativeUrl of the original request.
remarks: 'Example: "/teams/SPClientTest/SitePages/Home.aspx"'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly serverRequestPath: string;'
return:
type: string
- name: sitePagesEnabled
uid: '@microsoft/sp-page-context!SPSite#sitePagesEnabled:member'
package: '@microsoft/sp-page-context!'
fullName: sitePagesEnabled
summary: Returns true if SitePages are enabled on this SPSite.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'readonly sitePagesEnabled: boolean;'
return:
type: boolean