-
Notifications
You must be signed in to change notification settings - Fork 63
/
office.meetingsuggestion.yml
194 lines (164 loc) · 7.98 KB
/
office.meetingsuggestion.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
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
### YamlMime:TSType
name: Office.MeetingSuggestion
uid: 'outlook!Office.MeetingSuggestion:interface'
package: outlook!
fullName: Office.MeetingSuggestion
summary: >-
Represents a suggested meeting found in an item. Read mode only.
The list of meetings suggested in an email message is returned in the `meetingSuggestions` property of the `Entities`
object that's returned when the `getEntities` or `getEntitiesByType` method is called on the active item.
The start and end values are string representations of a `Date` object that contains the date and time at which the
suggested meeting is to begin and end. The values are in the default time zone specified for the current user.
**Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still
supported. We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
For guidance on how to implement these rules, see [Contextual Outlook
add-ins](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)<!-- -->.
remarks: >-
**[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)<!-- -->**:
Read
#### Examples
```TypeScript
const item = Office.context.mailbox.item;
// Get an array of strings that represent meeting suggestions in the current item's body.
const meetingSuggestions = item.getEntitiesByType(Office.MailboxEnums.EntityType.MeetingSuggestion);
console.log("There are " + meetingSuggestions.length + " meeting suggestions.")
meetingSuggestions.forEach(function (meetingSuggestion) {
console.log("Subject: " + JSON.stringify(meetingSuggestion.subject));
console.log("Attendees: " + JSON.stringify(meetingSuggestion.attendees));
console.log("Location: " + JSON.stringify(meetingSuggestion.location));
console.log("Start: " + JSON.stringify(meetingSuggestion.start));
console.log("End: " + JSON.stringify(meetingSuggestion.end));
console.log("Meeting: " + JSON.stringify(meetingSuggestion.meetingString));
});
```
isPreview: false
isDeprecated: true
customDeprecatedMessage: >-
Use [regular expression rules](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)
instead.
type: interface
properties:
- name: attendees
uid: 'outlook!Office.MeetingSuggestion#attendees:member'
package: outlook!
fullName: attendees
summary: >-
Gets the attendees for a suggested meeting.
**Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are
still supported. We recommend updating your contextual add-in to use regular expression rules as an alternative
solution. For guidance on how to implement these rules, see [Contextual Outlook
add-ins](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)<!-- -->.
remarks: ''
isPreview: false
isDeprecated: true
customDeprecatedMessage: >-
Use [regular expression rules](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)
instead.
syntax:
content: 'attendees: EmailUser[];'
return:
type: '<xref uid="outlook!Office.EmailUser:interface" />[]'
- name: end
uid: 'outlook!Office.MeetingSuggestion#end:member'
package: outlook!
fullName: end
summary: >-
Gets the date and time that a suggested meeting is to end.
**Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are
still supported. We recommend updating your contextual add-in to use regular expression rules as an alternative
solution. For guidance on how to implement these rules, see [Contextual Outlook
add-ins](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)<!-- -->.
remarks: ''
isPreview: false
isDeprecated: true
customDeprecatedMessage: >-
Use [regular expression rules](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)
instead.
syntax:
content: 'end: string;'
return:
type: string
- name: location
uid: 'outlook!Office.MeetingSuggestion#location:member'
package: outlook!
fullName: location
summary: >-
Gets the location of a suggested meeting.
**Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are
still supported. We recommend updating your contextual add-in to use regular expression rules as an alternative
solution. For guidance on how to implement these rules, see [Contextual Outlook
add-ins](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)<!-- -->.
remarks: ''
isPreview: false
isDeprecated: true
customDeprecatedMessage: >-
Use [regular expression rules](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)
instead.
syntax:
content: 'location: string;'
return:
type: string
- name: meetingString
uid: 'outlook!Office.MeetingSuggestion#meetingString:member'
package: outlook!
fullName: meetingString
summary: >-
Gets a string that was identified as a meeting suggestion.
**Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are
still supported. We recommend updating your contextual add-in to use regular expression rules as an alternative
solution. For guidance on how to implement these rules, see [Contextual Outlook
add-ins](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)<!-- -->.
remarks: ''
isPreview: false
isDeprecated: true
customDeprecatedMessage: >-
Use [regular expression rules](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)
instead.
syntax:
content: 'meetingString: string;'
return:
type: string
- name: start
uid: 'outlook!Office.MeetingSuggestion#start:member'
package: outlook!
fullName: start
summary: >-
Gets the date and time that a suggested meeting is to begin.
**Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are
still supported. We recommend updating your contextual add-in to use regular expression rules as an alternative
solution. For guidance on how to implement these rules, see [Contextual Outlook
add-ins](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)<!-- -->.
remarks: ''
isPreview: false
isDeprecated: true
customDeprecatedMessage: >-
Use [regular expression rules](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)
instead.
syntax:
content: 'start: string;'
return:
type: string
- name: subject
uid: 'outlook!Office.MeetingSuggestion#subject:member'
package: outlook!
fullName: subject
summary: >-
Gets the subject of a suggested meeting.
**Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are
still supported. We recommend updating your contextual add-in to use regular expression rules as an alternative
solution. For guidance on how to implement these rules, see [Contextual Outlook
add-ins](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)<!-- -->.
remarks: ''
isPreview: false
isDeprecated: true
customDeprecatedMessage: >-
Use [regular expression rules](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)
instead.
syntax:
content: 'subject: string;'
return:
type: string