-
Notifications
You must be signed in to change notification settings - Fork 16
/
sptimezone.yml
113 lines (108 loc) · 3.82 KB
/
sptimezone.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
### YamlMime:TSType
name: SPTimeZone
uid: '@microsoft/sp-page-context!SPTimeZone:class'
package: '@microsoft/sp-page-context!'
fullName: SPTimeZone
summary: >-
It provides timezone information from SharePoint. A conversion from UTC to local time can be calculated by using the
following formula.
remarks: >-
```
isDaylightSavingsTime = isCurrentDate after DaylightSavingsDate but before the StandardDate
LocalTime = UTCTime - Offset - (isDaylightSavingsTime ? daylightOffset : standardOffset)
June 11, 2 A.M. PST = June 11, 9 A.M. - (480 minutes) - (-60 minutes)
```
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or
create subclasses that extend the `SPTimeZone` class.
isPreview: true
isDeprecated: false
type: class
properties:
- name: daylightDate
uid: '@microsoft/sp-page-context!SPTimeZone#daylightDate:member'
package: '@microsoft/sp-page-context!'
fullName: daylightDate
summary: Gets the date on which daylight time begins for the time zone.
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: 'readonly daylightDate: ISPSystemTime;'
return:
type: '<xref uid="@microsoft/sp-page-context!ISPSystemTime:interface" />'
- name: daylightOffset
uid: '@microsoft/sp-page-context!SPTimeZone#daylightOffset:member'
package: '@microsoft/sp-page-context!'
fullName: daylightOffset
summary: >-
Gets the offset in the number of minutes that daylight time for the time zone differs from Coordinated Universal
Time (UTC).
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: 'readonly daylightOffset: number;'
return:
type: number
- name: description
uid: '@microsoft/sp-page-context!SPTimeZone#description:member'
package: '@microsoft/sp-page-context!'
fullName: description
summary: Gets the description for the time zone.
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: 'readonly description: string;'
return:
type: string
- name: id
uid: '@microsoft/sp-page-context!SPTimeZone#id:member'
package: '@microsoft/sp-page-context!'
fullName: id
summary: Gets the ID of the time zone.
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: 'readonly id: number;'
return:
type: number
- name: offset
uid: '@microsoft/sp-page-context!SPTimeZone#offset:member'
package: '@microsoft/sp-page-context!'
fullName: offset
summary: Gets the offset in the number of minutes that the time zone differs from Coordinated Universal Time (UTC).
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: 'readonly offset: number;'
return:
type: number
- name: standardDate
uid: '@microsoft/sp-page-context!SPTimeZone#standardDate:member'
package: '@microsoft/sp-page-context!'
fullName: standardDate
summary: Gets the date on which standard time begins for the time zone.
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: 'readonly standardDate: ISPSystemTime;'
return:
type: '<xref uid="@microsoft/sp-page-context!ISPSystemTime:interface" />'
- name: standardOffset
uid: '@microsoft/sp-page-context!SPTimeZone#standardOffset:member'
package: '@microsoft/sp-page-context!'
fullName: standardOffset
summary: >-
Gets the offset in the number of minutes that standard time for the time zone differs from coordinated universal
time (UTC).
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: 'readonly standardOffset: number;'
return:
type: number