/
office.recurrencetimezone.yml
88 lines (69 loc) · 2.6 KB
/
office.recurrencetimezone.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
### YamlMime:TSType
name: Office.RecurrenceTimeZone
uid: 'outlook!Office.RecurrenceTimeZone:interface'
package: outlook!
fullName: Office.RecurrenceTimeZone
summary: Represents the time zone of the recurrence.
remarks: >-
\[ [API set: Mailbox 1.7](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!-- -->**:
**read item**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!-- -->**:
Compose or Read
#### Examples
```TypeScript
// This example gets the Recurrence object of an appointment item.
Office.context.mailbox.item.recurrence.getAsync(callback);
function callback(asyncResult) {
const context = asyncResult.context;
const recurrence = asyncResult.value;
if (!recurrence) {
//if (recurrence == null) {
console.log("One-time appointment or meeting");
} else {
console.log(JSON.stringify(recurrence));
}
}
// The following example shows the results of the getAsync call that retrieves the recurrence for a series.
// NOTE: In this example, seriesTimeObject is a placeholder for the JSON representing the
// recurrence.seriesTime property. You should use the SeriesTime object's methods to get the
// recurrence date and time properties.
Recurrence = {
"recurrenceType": "weekly",
"recurrenceProperties": {"interval": 2, "days": ["mon","thu","fri"], "firstDayOfWeek": "sun"},
"seriesTime": {seriesTimeObject},
"recurrenceTimeZone": {"name": "Pacific Standard Time", "offset": -480}
}
```
isPreview: false
isDeprecated: false
type: interface
properties:
- name: name
uid: 'outlook!Office.RecurrenceTimeZone#name:member'
package: outlook!
fullName: name
summary: Represents the name of the recurrence time zone.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'name: MailboxEnums.RecurrenceTimeZone | string;'
return:
type: '<xref uid="outlook!Office.MailboxEnums.RecurrenceTimeZone:enum" /> | string'
- name: offset
uid: 'outlook!Office.RecurrenceTimeZone#offset:member'
package: outlook!
fullName: offset
summary: >-
Integer value representing the difference in minutes between the local time zone and UTC at the date that the
meeting series began.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'offset?: number;'
return:
type: number