Office.MeetingSuggestion interface
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.
Remarks
Minimum permission level: read item
Applicable Outlook mode: Read
Examples
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));
});
Properties
| attendees | 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. |
| end | 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. |
| location | 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. |
| meeting |
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. |
| start | 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. |
| subject | 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. |
Property Details
attendees
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.
attendees: EmailUser[];Property Value
end
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.
end: string;Property Value
string
location
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.
location: string;Property Value
string
meetingString
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.
meetingString: string;Property Value
string
start
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.
start: string;Property Value
string
subject
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.
subject: string;Property Value
string
Office Add-ins