* | An {@link Office.TableData} object, and the shape of the table matches the bound table. |
- * The specified set of rows and/or headers are written, if no other data in surrounding cells will be overwritten. Note: If you specify formulas in the TableData object you pass for the *data* parameter, you might not get the results you expect due to the "calculated columns" feature of Excel, which automatically duplicates formulas within a column. To work around this when you want to write *data* that contains formulas to a bound table, try specifying the data as an array of arrays (instead of a TableData object), and specify the *coercionType* as Microsoft.Office.Matrix or "matrix". |
+ * The specified set of rows and/or headers are written, if no other data in surrounding cells will be overwritten. **Note**: If you specify formulas in the TableData object you pass for the *data* parameter, you might not get the results you expect due to the "calculated columns" feature of Excel, which automatically duplicates formulas within a column. To work around this when you want to write *data* that contains formulas to a bound table, try specifying the data as an array of arrays (instead of a TableData object), and specify the *coercionType* as Microsoft.Office.Matrix or "matrix". |
*
*
*
@@ -2654,7 +2654,7 @@ declare namespace Office {
*
*
* | An {@link Office.TableData} object, and the shape of the table matches the bound table. |
- * The specified set of rows and/or headers are written, if no other data in surrounding cells will be overwritten. Note: If you specify formulas in the TableData object you pass for the *data* parameter, you might not get the results you expect due to the "calculated columns" feature of Excel, which automatically duplicates formulas within a column. To work around this when you want to write *data* that contains formulas to a bound table, try specifying the data as an array of arrays (instead of a TableData object), and specify the *coercionType* as Microsoft.Office.Matrix or "matrix". |
+ * The specified set of rows and/or headers are written, if no other data in surrounding cells will be overwritten. **Note**: If you specify formulas in the TableData object you pass for the *data* parameter, you might not get the results you expect due to the "calculated columns" feature of Excel, which automatically duplicates formulas within a column. To work around this when you want to write *data* that contains formulas to a bound table, try specifying the data as an array of arrays (instead of a TableData object), and specify the *coercionType* as Microsoft.Office.Matrix or "matrix". |
*
*
*
@@ -2825,7 +2825,7 @@ declare namespace Office {
* By default, adding a table in Excel assigns the name "Table1" for the first table you add, "Table2" for the second table you add, and so on.
* To assign a meaningful name for a table in the Excel UI, use the Table Name property on the Table Tools | Design tab of the ribbon.
*
- * Note: In Excel, when specifying a table as a named item, you must fully qualify the name to include the worksheet name in the name of
+ * **Note**: In Excel, when specifying a table as a named item, you must fully qualify the name to include the worksheet name in the name of
* the table in this format: "Sheet1!Table1"
*
* For Word, the itemName parameter refers to the Title property of a Rich Text content control. (You can't bind to content controls other
@@ -2835,7 +2835,7 @@ declare namespace Office {
* control from the Controls group on the Developer tab of the ribbon, use the Properties command in the Controls group to display the Content
* Control Properties dialog box. Then set the Title property of the content control to the name you want to reference from your code.
*
- * Note: In Word, if there are multiple Rich Text content controls with the same Title property value (name), and you try to bind to one
+ * **Note**: In Word, if there are multiple Rich Text content controls with the same Title property value (name), and you try to bind to one
* these content controls with this method (by specifying its name as the itemName parameter), the operation will fail.
*
* **Support details**
@@ -2871,7 +2871,7 @@ declare namespace Office {
* By default, adding a table in Excel assigns the name "Table1" for the first table you add, "Table2" for the second table you add, and so on.
* To assign a meaningful name for a table in the Excel UI, use the Table Name property on the Table Tools | Design tab of the ribbon.
*
- * Note: In Excel, when specifying a table as a named item, you must fully qualify the name to include the worksheet name in the name of
+ * **Note**: In Excel, when specifying a table as a named item, you must fully qualify the name to include the worksheet name in the name of
* the table in this format: "Sheet1!Table1"
*
* For Word, the itemName parameter refers to the Title property of a Rich Text content control. (You can't bind to content controls other
@@ -2881,7 +2881,7 @@ declare namespace Office {
* control from the Controls group on the Developer tab of the ribbon, use the Properties command in the Controls group to display the Content
* Control Properties dialog box. Then set the Title property of the content control to the name you want to reference from your code.
*
- * Note: In Word, if there are multiple Rich Text content controls with the same Title property value (name), and you try to bind to one
+ * **Note**: In Word, if there are multiple Rich Text content controls with the same Title property value (name), and you try to bind to one
* these content controls with this method (by specifying its name as the itemName parameter), the operation will fail.
*
* **Support details**
@@ -4542,7 +4542,7 @@ declare namespace Office {
*
* | Word | If there is no selection and the insertion point is at a valid location, the specified `data` is inserted at the insertion point | If `data` is a string, the specified text is inserted. |
* | | If `data` is an array of arrays ("matrix") or a TableData object, a new Word table is inserted. |
- * | | If `data` is HTML, the specified HTML is inserted. (Important: If any of the HTML you insert is invalid, Word won't raise an error. Word will insert as much of the HTML as it can and omits any invalid data). |
+ * | | If `data` is HTML, the specified HTML is inserted. (**Important**: If any of the HTML you insert is invalid, Word won't raise an error. Word will insert as much of the HTML as it can and omits any invalid data). |
* | | If `data` is Office Open XML, the specified XML is inserted. |
* | | If `data` is a base64 encoded image stream, the specified image is inserted. |
* | If there is a selection | It will be replaced with the specified `data` following the same rules as above. |
@@ -4659,7 +4659,7 @@ declare namespace Office {
*
* | Word | If there is no selection and the insertion point is at a valid location, the specified `data` is inserted at the insertion point | If `data` is a string, the specified text is inserted. |
* | | If `data` is an array of arrays ("matrix") or a TableData object, a new Word table is inserted. |
- * | | If `data` is HTML, the specified HTML is inserted. (Important: If any of the HTML you insert is invalid, Word won't raise an error. Word will insert as much of the HTML as it can and omits any invalid data). |
+ * | | If `data` is HTML, the specified HTML is inserted. (**Important**: If any of the HTML you insert is invalid, Word won't raise an error. Word will insert as much of the HTML as it can and omits any invalid data). |
* | | If `data` is Office Open XML, the specified XML is inserted. |
* | | If `data` is a base64 encoded image stream, the specified image is inserted. |
* | If there is a selection | It will be replaced with the specified `data` following the same rules as above. |
@@ -5151,7 +5151,7 @@ declare namespace Office {
/**
* Project documents only. Get the maximum index of the collection of resources in the current project.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
@@ -5177,7 +5177,7 @@ declare namespace Office {
/**
* Project documents only. Get the maximum index of the collection of resources in the current project.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
* The `value` property of the result is the highest index number in the current project's resource collection.
@@ -5202,7 +5202,7 @@ declare namespace Office {
/**
* Project documents only. Get the maximum index of the collection of tasks in the current project.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
@@ -5228,7 +5228,7 @@ declare namespace Office {
/**
* Project documents only. Get the maximum index of the collection of tasks in the current project.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
* The `value` property of the result is the highest index number in the current project's task collection.
@@ -5253,7 +5253,7 @@ declare namespace Office {
/**
* Project documents only. Get the GUID of the resource that has the specified index in the resource collection.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param resourceIndex The index of the resource in the collection of resources for the project.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -5280,7 +5280,7 @@ declare namespace Office {
/**
* Project documents only. Get the GUID of the resource that has the specified index in the resource collection.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param resourceIndex The index of the resource in the collection of resources for the project.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
@@ -5306,7 +5306,7 @@ declare namespace Office {
/**
* Project documents only. Get the GUID of the task that has the specified index in the task collection.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param taskIndex The index of the task in the collection of tasks for the project.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -5333,7 +5333,7 @@ declare namespace Office {
/**
* Project documents only. Get the GUID of the task that has the specified index in the task collection.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param taskIndex The index of the task in the collection of tasks for the project.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
@@ -5359,7 +5359,7 @@ declare namespace Office {
/**
* Project documents only. Set resource field for specified resource Id.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param resourceId Either a string or value of the Resource Id.
* @param fieldId Resource Fields.
@@ -5387,7 +5387,7 @@ declare namespace Office {
/**
* Project documents only. Set resource field for specified resource Id.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param resourceId Either a string or value of the Resource Id.
* @param fieldId Resource Fields.
@@ -5414,7 +5414,7 @@ declare namespace Office {
/**
* Project documents only. Set task field for specified task Id.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param taskId Either a string or value of the Task Id.
* @param fieldId Task Fields.
@@ -5442,7 +5442,7 @@ declare namespace Office {
/**
* Project documents only. Set task field for specified task Id.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param taskId Either a string or value of the Task Id.
* @param fieldId Task Fields.
@@ -5662,7 +5662,7 @@ declare namespace Office {
/**
* Adds an event handler for the settingsChanged event.
*
- * Important: Your add-in's code can register a handler for the settingsChanged event when the add-in is running with any Excel client, but
+ * **Important**: Your add-in's code can register a handler for the settingsChanged event when the add-in is running with any Excel client, but
* the event will fire only when the add-in is loaded with a spreadsheet that is opened in Excel Online, and more than one user is editing the
* spreadsheet (co-authoring). Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios.
*
@@ -5719,7 +5719,7 @@ declare namespace Office {
/**
* Adds an event handler for the settingsChanged event.
*
- * Important: Your add-in's code can register a handler for the settingsChanged event when the add-in is running with any Excel client, but
+ * **Important**: Your add-in's code can register a handler for the settingsChanged event when the add-in is running with any Excel client, but
* the event will fire only when the add-in is loaded with a spreadsheet that is opened in Excel Online, and more than one user is editing the
* spreadsheet (co-authoring). Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios.
*
@@ -5862,7 +5862,7 @@ declare namespace Office {
/**
* Removes the specified setting.
*
- * Important: Be aware that the Settings.remove method affects only the in-memory copy of the settings property bag. To persist the removal of
+ * **Important**: Be aware that the Settings.remove method affects only the in-memory copy of the settings property bag. To persist the removal of
* the specified setting in the document, at some point after calling the Settings.remove method and before the add-in is closed, you must
* call the Settings.saveAsync method.
*
@@ -5970,7 +5970,7 @@ declare namespace Office {
* set and get methods to work with the in-memory copy of the settings property bag. When you want to persist the settings so that they are
* available the next time the add-in is used, use the saveAsync method.
*
- * Note: The saveAsync method persists the in-memory settings property bag into the document file. However, the changes to the document file
+ * **Note**: The saveAsync method persists the in-memory settings property bag into the document file. However, the changes to the document file
* itself are saved only when the user (or AutoRecover setting) saves the document to the file system. The refreshAsync method is only useful
* in coauthoring scenarios when other instances of the same add-in might change the settings and those changes should be made available to
* all instances.
@@ -6027,7 +6027,7 @@ declare namespace Office {
* set and get methods to work with the in-memory copy of the settings property bag. When you want to persist the settings so that they are
* available the next time the add-in is used, use the saveAsync method.
*
- * Note: The saveAsync method persists the in-memory settings property bag into the document file. However, the changes to the document file
+ * **Note**: The saveAsync method persists the in-memory settings property bag into the document file. However, the changes to the document file
* itself are saved only when the user (or AutoRecover setting) saves the document to the file system. The refreshAsync method is only useful
* in coauthoring scenarios when other instances of the same add-in might change the settings and those changes should be made available to
* all instances.
@@ -6078,7 +6078,7 @@ declare namespace Office {
/**
* Sets or creates the specified setting.
*
- * Important: Be aware that the Settings.set method affects only the in-memory copy of the settings property bag.
+ * **Important**: Be aware that the Settings.set method affects only the in-memory copy of the settings property bag.
* To make sure that additions or changes to settings will be available to your add-in the next time the document is opened, at some point
* after calling the Settings.set method and before the add-in is closed, you must call the Settings.saveAsync method to persist settings in
* the document.
@@ -6128,7 +6128,7 @@ declare namespace Office {
* The settingsChanged event was designed to let you to handle potential conflicts when two or more users are
* attempting to save settings at the same time when your add-in is used in a shared (co-authored) document.
*
- * **Important:** Your add-in's code can register a handler for the settingsChanged event when the add-in
+ * **Important**: Your add-in's code can register a handler for the settingsChanged event when the add-in
* is running with any Excel client, but the event will fire only when the add-in is loaded with a spreadsheet
* that is opened in Excel Online, and more than one user is editing the spreadsheet (co-authoring).
* Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios.
@@ -10541,7 +10541,7 @@ declare namespace Office {
/**
* Represents an attachment on an item from the server. Read mode only.
*
- * An array of AttachmentDetail objects is returned as the attachments property of an Appointment or Message object.
+ * An array of **AttachmentDetails** objects is returned as the attachments property of an appointment or message item.
*
* [Api set: Mailbox 1.0]
*
@@ -11741,16 +11741,18 @@ declare namespace Office {
/**
* The subclass of {@link Office.Item} dealing with appointments.
*
- * Important: This is an internal Outlook object, not directly exposed through existing interfaces.
- * You should treat this as a mode of Office.context.mailbox.item. Refer to the Object Model pages for more information.
+ * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
+ * You should treat this as a mode of Office.context.mailbox.item. Refer to the
+ * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information.
*/
interface Appointment extends Item {
}
/**
* The appointment organizer mode of {@link Office.Item | Office.context.mailbox.item}.
*
- * Important: This is an internal Outlook object, not directly exposed through existing interfaces.
- * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the Object Model pages for more information.
+ * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
+ * You should treat this as a mode of Office.context.mailbox.item. Refer to the
+ * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information.
*/
interface AppointmentCompose extends Appointment, ItemCompose {
/**
@@ -11765,32 +11767,6 @@ declare namespace Office {
* | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Appointment Organizer |
*/
body: Body;
- /**
- * Gets the date and time that an item was created. Read mode only.
- *
- * [Api set: Mailbox 1.0]
- *
- * @remarks
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level} | ReadItem |
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Appointment Organizer |
- */
- dateTimeCreated: Date;
- /**
- * Gets the date and time that an item was last modified. Read mode only.
- *
- * [Api set: Mailbox 1.0]
- *
- * @remarks
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level} | ReadItem |
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Appointment Organizer |
- *
- * Note: This member is not supported in Outlook for iOS or Outlook for Android.
- */
- dateTimeModified: Date;
/**
* Gets or sets the date and time that the appointment is to end.
*
@@ -11904,9 +11880,9 @@ declare namespace Office {
* The recurrence property returns a recurrence object for recurring appointments or meetings requests if an item is a series or an instance
* in a series. `null` is returned for single appointments and meeting requests of single appointments.
*
- * Note: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request.
+ * **Note**: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request.
*
- * Note: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single
+ * **Note**: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single
* appointment and NOT a part of a series.
*
* [Api set: Mailbox 1.7]
@@ -11938,7 +11914,7 @@ declare namespace Office {
* In OWA and Outlook, the seriesId returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to.
* However, in iOS and Android, the seriesId returns the REST ID of the parent item.
*
- * Note: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier.
+ * **Note**: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier.
* The seriesId property is not identical to the Outlook IDs used by the Outlook REST API.
* Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId.
* For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}.
@@ -12295,7 +12271,7 @@ declare namespace Office {
*
* In the Outlook desktop client, if the message is an inline reply, the close method has no effect.
*
- * Note: In Outlook on the web, if the item is an appointment and it has previously been saved using saveAsync, the user is prompted to save,
+ * **Note**: In Outlook on the web, if the item is an appointment and it has previously been saved using saveAsync, the user is prompted to save,
* discard, or cancel even if no changes have occurred since the item was last saved.
*
* [Api set: Mailbox 1.3]
@@ -12330,7 +12306,7 @@ declare namespace Office {
/**
* Gets initialization data passed when the add-in is activated by an actionable message.
*
- * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web for Office 365.
+ * **Note**: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web for Office 365.
*
* [Api set: Mailbox Preview]
*
@@ -12590,11 +12566,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -12634,11 +12610,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -12667,11 +12643,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -12701,11 +12677,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -12842,8 +12818,9 @@ declare namespace Office {
/**
* The appointment attendee mode of {@link Office.Item | Office.context.mailbox.item}.
*
- * Important: This is an internal Outlook object, not directly exposed through existing interfaces.
- * You should treat this as a mode of 'Office.context.mailbox.item'. Refer to the Object Model pages for more information.
+ * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
+ * You should treat this as a mode of Office.context.mailbox.item. Refer to the
+ * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information.
*/
interface AppointmentRead extends Appointment, ItemRead {
/**
@@ -12857,7 +12834,7 @@ declare namespace Office {
*
* | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Appointment Attendee |
*
- * Note: Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned. For more information, see
+ * **Note**: Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned. For more information, see
* {@link https://support.office.com/article/Blocked-attachments-in-Outlook-434752E1-02D3-4E90-9124-8B81E49A8519 | Blocked attachments in Outlook}.
*
*/
@@ -12875,7 +12852,7 @@ declare namespace Office {
*/
body: Body;
/**
- * Gets the date and time that an item was created. Read mode only.
+ * Gets the date and time that an item was created.
*
* [Api set: Mailbox 1.0]
*
@@ -12887,7 +12864,7 @@ declare namespace Office {
*/
dateTimeCreated: Date;
/**
- * Gets the date and time that an item was last modified. Read mode only.
+ * Gets the date and time that an item was last modified.
*
* [Api set: Mailbox 1.0]
*
@@ -12897,7 +12874,7 @@ declare namespace Office {
*
* ) => void): void;
/**
- * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
+ * Gets an attachment from a message or appointment and returns it as an **AttachmentContent** object.
*
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
* the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or
@@ -13806,7 +13734,7 @@ declare namespace Office {
/**
* Gets initialization data passed when the add-in is {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}.
*
- * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
+ * **Note**: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
* for Office 365.
*
* [Api set: Mailbox Preview]
@@ -13950,8 +13878,9 @@ declare namespace Office {
/**
* The compose mode of {@link Office.Item | Office.context.mailbox.item}.
*
- * Important: This is an internal Outlook object, not directly exposed through existing interfaces.
- * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the Object Model pages for more information.
+ * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
+ * You should treat this as a mode of Office.context.mailbox.item. Refer to the
+ * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information.
*/
interface ItemCompose extends Item {
/**
@@ -14237,7 +14166,7 @@ declare namespace Office {
*
* In the Outlook desktop client, if the message is an inline reply, the close method has no effect.
*
- * Note: In Outlook on the web, if the item is an appointment and it has previously been saved using saveAsync, the user is prompted to save,
+ * **Note**: In Outlook on the web, if the item is an appointment and it has previously been saved using saveAsync, the user is prompted to save,
* discard, or cancel even if no changes have occurred since the item was last saved.
*
* [Api set: Mailbox 1.3]
@@ -14272,7 +14201,7 @@ declare namespace Office {
/**
* Gets initialization data passed when the add-in is activated by an actionable message.
*
- * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web for Office 365.
+ * **Note**: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web for Office 365.
*
* [Api set: Mailbox Preview]
*
@@ -14467,11 +14396,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -14513,11 +14442,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -14546,11 +14475,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -14581,11 +14510,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -14724,8 +14653,9 @@ declare namespace Office {
/**
* The read mode of {@link Office.Item | Office.context.mailbox.item}.
*
- * Important: This is an internal Outlook object, not directly exposed through existing interfaces.
- * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the Object Model pages for more information.
+ * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
+ * You should treat this as a mode of Office.context.mailbox.item. Refer to the
+ * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information.
*/
interface ItemRead extends Item {
/**
@@ -14738,7 +14668,7 @@ declare namespace Office {
*
* | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Read |
*
- * Note: Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned.
+ * **Note**: Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned.
* For more information, see
* {@link https://support.office.com/article/Blocked-attachments-in-Outlook-434752E1-02D3-4E90-9124-8B81E49A8519 | Blocked attachments in Outlook}.
*
@@ -14788,7 +14718,7 @@ declare namespace Office {
* If an item identifier is required, the saveAsync method can be used to save the item to the store, which will return the item identifier
* in the asyncResult.value parameter in the callback function.
*
- * Note: The identifier returned by the itemId property is the same as the Exchange Web Services item identifier.
+ * **Note**: The identifier returned by the itemId property is the same as the Exchange Web Services item identifier.
* The itemId property is not identical to the Outlook Entry ID or the ID used by the Outlook REST API.
* Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId.
* For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api#get-the-item-id | Use the Outlook REST APIs from an Outlook add-in}.
@@ -14845,7 +14775,7 @@ declare namespace Office {
* attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI.
* If this isn't possible, then no error message is thrown.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -14870,7 +14800,7 @@ declare namespace Office {
* attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI.
* If this isn't possible, then no error message is thrown.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -14888,7 +14818,7 @@ declare namespace Office {
/**
* Gets initialization data passed when the add-in is {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}.
*
- * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
+ * **Note**: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
* for Office 365.
*
* [Api set: Mailbox Preview]
@@ -14917,7 +14847,7 @@ declare namespace Office {
/**
* Gets initialization data passed when the add-in is {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}.
*
- * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
+ * **Note**: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
* for Office 365.
*
* [Api set: Mailbox Preview]
@@ -14940,7 +14870,7 @@ declare namespace Office {
/**
* Gets the entities found in the selected item's body.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -14954,7 +14884,7 @@ declare namespace Office {
/**
* Gets an array of all the entities of the specified entity type found in the selected item's body.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -15023,7 +14953,7 @@ declare namespace Office {
* The getFilteredEntitiesByName method returns the entities that match the regular expression defined in the ItemHasKnownEntity rule element
* in the manifest XML file with the specified FilterName element value.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -15053,7 +14983,7 @@ declare namespace Office {
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
* Instead, use the Body.getAsync method to retrieve the entire body.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -15079,7 +15009,7 @@ declare namespace Office {
* and should not attempt to return the entire body of the item.
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -15098,7 +15028,7 @@ declare namespace Office {
/**
* Gets the entities found in a highlighted match a user has selected. Highlighted matches apply to contextual add-ins.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.6]
*
@@ -15123,7 +15053,7 @@ declare namespace Office {
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
* Instead, use the Body.getAsync method to retrieve the entire body.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.6]
*
@@ -15143,8 +15073,9 @@ declare namespace Office {
/**
* A subclass of {@link Office.Item} for messages.
*
- * Important: This is an internal Outlook object, not directly exposed through existing interfaces.
- * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the Object Model pages for more information.
+ * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
+ * You should treat this as a mode of Office.context.mailbox.item. Refer to the
+ * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information.
*/
interface Message extends Item {
/**
@@ -15171,8 +15102,9 @@ declare namespace Office {
/**
* The message compose mode of {@link Office.Item | Office.context.mailbox.item}.
*
- * Important: This is an internal Outlook object, not directly exposed through existing interfaces.
- * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the Object Model pages for more information.
+ * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
+ * You should treat this as a mode of Office.context.mailbox.item. Refer to the
+ * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information.
*/
interface MessageCompose extends Message, ItemCompose {
/**
@@ -15234,32 +15166,6 @@ declare namespace Office {
* | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Message Compose |
*/
conversationId: string;
- /**
- * Gets the date and time that an item was created. Read mode only.
- *
- * [Api set: Mailbox 1.0]
- *
- * @remarks
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level} | ReadItem |
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Message Compose |
- */
- dateTimeCreated: Date;
- /**
- * Gets the date and time that an item was last modified. Read mode only.
- *
- * [Api set: Mailbox 1.0]
- *
- * @remarks
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level} | ReadItem |
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Message Compose |
- *
- * Note: This member is not supported in Outlook for iOS or Outlook for Android.
- */
- dateTimeModified: Date;
/**
* Gets the email address of the sender of a message.
*
@@ -15320,35 +15226,13 @@ declare namespace Office {
* | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Message Compose |
*/
notificationMessages: NotificationMessages;
- /**
- * Gets or sets the recurrence pattern of an appointment. Gets the recurrence pattern of a meeting request.
- * Read and compose modes for appointment items. Read mode for meeting request items.
- *
- * The recurrence property returns a recurrence object for recurring appointments or meetings requests if an item is a series or an instance
- * in a series. `null` is returned for single appointments and meeting requests of single appointments.
- * `undefined` is returned for messages that are not meeting requests.
- *
- * Note: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request.
- *
- * Note: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single appointment
- * and NOT a part of a series.
- *
- * [Api set: Mailbox 1.7]
- *
- * @remarks
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level} | ReadItem |
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Message Compose |
- */
- recurrence: Recurrence;
/**
* Gets the id of the series that an instance belongs to.
*
* In OWA and Outlook, the seriesId returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to.
* However, in iOS and Android, the seriesId returns the REST ID of the parent item.
*
- * Note: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier.
+ * **Note**: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier.
* The seriesId property is not identical to the Outlook IDs used by the Outlook REST API.
* Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId.
* For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}.
@@ -15708,7 +15592,7 @@ declare namespace Office {
*
* In the Outlook desktop client, if the message is an inline reply, the close method has no effect.
*
- * Note: In Outlook on the web, if the item is an appointment and it has previously been saved using saveAsync, the user is prompted to save,
+ * **Note**: In Outlook on the web, if the item is an appointment and it has previously been saved using saveAsync, the user is prompted to save,
* discard, or cancel even if no changes have occurred since the item was last saved.
*
* [Api set: Mailbox 1.3]
@@ -15743,7 +15627,7 @@ declare namespace Office {
/**
* Gets initialization data passed when the add-in is activated by an actionable message.
*
- * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
+ * **Note**: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
* for Office 365.
*
* [Api set: Mailbox Preview]
@@ -16007,11 +15891,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -16052,11 +15936,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -16084,11 +15968,11 @@ declare namespace Office {
* Since appointments have no draft state, if saveAsync is called on an appointment in compose mode, the item will be saved as a normal
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -16119,11 +16003,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -16259,8 +16143,9 @@ declare namespace Office {
/**
* The message read mode of {@link Office.Item | Office.context.mailbox.item}.
*
- * Important: This is an internal Outlook object, not directly exposed through existing interfaces.
- * You should treat this as a mode of Office.context.mailbox.item. Refer to the Object Model pages for more information.
+ * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
+ * You should treat this as a mode of Office.context.mailbox.item. Refer to the
+ * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information.
*/
interface MessageRead extends Message, ItemRead {
/**
@@ -16274,7 +16159,7 @@ declare namespace Office {
*
* | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Message Read |
*
- * Note: Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned.
+ * **Note**: Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned.
* For more information, see
* {@link https://support.office.com/article/Blocked-attachments-in-Outlook-434752E1-02D3-4E90-9124-8B81E49A8519 | Blocked attachments in Outlook}.
*
@@ -16328,7 +16213,7 @@ declare namespace Office {
*/
conversationId: string;
/**
- * Gets the date and time that an item was created. Read mode only.
+ * Gets the date and time that an item was created.
*
* [Api set: Mailbox 1.0]
*
@@ -16340,7 +16225,7 @@ declare namespace Office {
*/
dateTimeCreated: Date;
/**
- * Gets the date and time that an item was last modified. Read mode only.
+ * Gets the date and time that an item was last modified.
*
* [Api set: Mailbox 1.0]
*
@@ -16350,7 +16235,7 @@ declare namespace Office {
*
* | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Message Read |
*
- * Note: This member is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This member is not supported in Outlook for iOS or Outlook for Android.
*/
dateTimeModified: Date;
/**
@@ -16359,7 +16244,7 @@ declare namespace Office {
* The from and sender properties represent the same person unless the message is sent by a delegate.
* In that case, the from property represents the delegator, and the sender property represents the delegate.
*
- * Note: The recipientType property of the EmailAddressDetails object in the from property is undefined.
+ * **Note**: The recipientType property of the EmailAddressDetails object in the from property is undefined.
*
* The from property returns an EmailAddressDetails object.
*
@@ -16444,7 +16329,7 @@ declare namespace Office {
* If an item identifier is required, the saveAsync method can be used to save the item to the store, which will return the item identifier
* in the asyncResult.value parameter in the callback function.
*
- * Note: The identifier returned by the itemId property is the same as the Exchange Web Services item identifier.
+ * **Note**: The identifier returned by the itemId property is the same as the Exchange Web Services item identifier.
* The itemId property is not identical to the Outlook Entry ID or the ID used by the Outlook REST API.
* Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId.
* For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api#get-the-item-id | Use the Outlook REST APIs from an Outlook add-in}.
@@ -16509,9 +16394,9 @@ declare namespace Office {
* in a series. `null` is returned for single appointments and meeting requests of single appointments.
* `undefined` is returned for messages that are not meeting requests.
*
- * Note: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request.
+ * **Note**: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request.
*
- * Note: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single appointment
+ * **Note**: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single appointment
* and NOT a part of a series.
*
* [Api set: Mailbox 1.7]
@@ -16529,7 +16414,7 @@ declare namespace Office {
* In OWA and Outlook, the seriesId returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to.
* However, in iOS and Android, the seriesId returns the REST ID of the parent item.
*
- * Note: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier.
+ * **Note**: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier.
* The seriesId property is not identical to the Outlook IDs used by the Outlook REST API.
* Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId.
* For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}.
@@ -16552,7 +16437,7 @@ declare namespace Office {
* The from and sender properties represent the same person unless the message is sent by a delegate.
* In that case, the from property represents the delegator, and the sender property represents the delegate.
*
- * Note: The recipientType property of the EmailAddressDetails object in the sender property is undefined.
+ * **Note**: The recipientType property of the EmailAddressDetails object in the sender property is undefined.
*
* [Api set: Mailbox 1.0]
*
@@ -16657,7 +16542,7 @@ declare namespace Office {
* attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI.
* If this isn't possible, then no error message is thrown.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -16682,7 +16567,7 @@ declare namespace Office {
* attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI.
* If this isn't possible, then no error message is thrown.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -16701,7 +16586,7 @@ declare namespace Office {
* Gets initialization data passed when the add-in is
* {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}.
*
- * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
+ * **Note**: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
* for Office 365.
*
* [Api set: Mailbox Preview]
@@ -16731,7 +16616,7 @@ declare namespace Office {
* Gets initialization data passed when the add-in is
* {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}.
*
- * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the
+ * **Note**: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the
* web for Office 365.
*
* [Api set: Mailbox Preview]
@@ -16754,7 +16639,7 @@ declare namespace Office {
/**
* Gets the entities found in the selected item's body.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -16768,7 +16653,7 @@ declare namespace Office {
/**
* Gets an array of all the entities of the specified entity type found in the selected item's body.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -16838,7 +16723,7 @@ declare namespace Office {
* The getFilteredEntitiesByName method returns the entities that match the regular expression defined in the ItemHasKnownEntity rule element
* in the manifest XML file with the specified FilterName element value.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -16868,7 +16753,7 @@ declare namespace Office {
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
* Instead, use the Body.getAsync method to retrieve the entire body.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -16894,7 +16779,7 @@ declare namespace Office {
* and should not attempt to return the entire body of the item.
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -16913,7 +16798,7 @@ declare namespace Office {
/**
* Gets the entities found in a highlighted match a user has selected. Highlighted matches apply to contextual add-ins.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.6]
*
@@ -16940,7 +16825,7 @@ declare namespace Office {
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
* Instead, use the Body.getAsync method to retrieve the entire body.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.6]
*
@@ -17278,7 +17163,7 @@ declare namespace Office {
*
* The ewsUrl value can be used by a remote service to make EWS calls to the user's mailbox. For example, you can create a remote service to {@link https://docs.microsoft.com/outlook/add-ins/get-attachments-of-an-outlook-item | get attachments from the selected item}.
*
- * Note: This member is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This member is not supported in Outlook for iOS or Outlook for Android.
*/
ewsUrl: string;
/**
@@ -17339,7 +17224,7 @@ declare namespace Office {
* Item IDs retrieved via a REST API (such as the Outlook Mail API or the Microsoft Graph) use a different format than the format used by
* Exchange Web Services (EWS). The convertToEwsId method converts a REST-formatted ID into the proper format for EWS.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.3]
*
@@ -17380,7 +17265,7 @@ declare namespace Office {
/**
* Converts an item ID formatted for EWS into REST format.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.3]
*
@@ -17431,7 +17316,7 @@ declare namespace Office {
* If the specified item identifier does not identify an existing appointment, a blank pane opens on the client computer or device, and
* no error message will be returned.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -17457,7 +17342,7 @@ declare namespace Office {
* Do not use the displayMessageForm with an itemId that represents an appointment. Use the displayAppointmentForm method to display
* an existing appointment, and displayNewAppointmentForm to display a form to create a new appointment.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -17486,7 +17371,7 @@ declare namespace Office {
*
* If any of the parameters exceed the specified size limits, or if an unknown parameter name is specified, an exception is thrown.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -17568,7 +17453,7 @@ declare namespace Office {
*
* The add-in should use the ewsUrl property to determine the correct URL to use when making EWS calls.
*
- * Note: It is recommended that add-ins use the REST APIs instead of Exchange Web Services whenever possible.
+ * **Note**: It is recommended that add-ins use the REST APIs instead of Exchange Web Services whenever possible.
*
* [Api set: Mailbox 1.5]
*
@@ -17690,13 +17575,13 @@ declare namespace Office {
* The XML result of the EWS call is provided as a string in the asyncResult.value property.
* If the result exceeds 1 MB in size, an error message is returned instead.
*
- * Note: This method is not supported in the following scenarios:
+ * **Note**: This method is not supported in the following scenarios:
*
* - In Outlook for iOS or Outlook for Android.
*
* - When the add-in is loaded in a Gmail mailbox.
*
- * Note: The server administrator must set OAuthAuthentication to true on the Client Access Server EWS directory to enable the
+ * **Note**: The server administrator must set OAuthAuthentication to true on the Client Access Server EWS directory to enable the
* makeEwsRequestAsync method to make EWS requests.
*
* *Version differences*
@@ -17779,7 +17664,7 @@ declare namespace Office {
/**
* Gets a string that was identified as a meeting suggestion.
*/
- meetingstring: string;
+ meetingString: string;
/**
* Gets the date and time that a suggested meeting is to begin.
*/
@@ -18577,7 +18462,7 @@ declare namespace Office {
/**
* Sets the recurrence pattern of an appointment series.
*
- * Note: setAsync should only be available for series items and not instance items.
+ * **Note**: setAsync should only be available for series items and not instance items.
*
* [Api set: Mailbox 1.7]
*
@@ -18604,7 +18489,7 @@ declare namespace Office {
/**
* Sets the recurrence pattern of an appointment series.
*
- * Note: setAsync should only be available for series items and not instance items.
+ * **Note**: setAsync should only be available for series items and not instance items.
*
* [Api set: Mailbox 1.7]
*
@@ -18746,7 +18631,7 @@ declare namespace Office {
*
* The RoamingSettings object is accessible via the roamingSettings property in the Office.context namespace.
*
- * Important: The RoamingSettings object is initialized from the persisted storage only when the add-in is first loaded.
+ * **Important**: The RoamingSettings object is initialized from the persisted storage only when the add-in is first loaded.
* For task panes, this means that it is only initialized when the task pane first opens.
* If the task pane navigates to another page or reloads the current page, the in-memory object is reset to its initial values, even if
* your add-in has persisted changes. The persisted changes will not be available until the task pane is closed and reopened.
@@ -19386,7 +19271,7 @@ declare namespace Office {
/**
* Gets the account type of the user associated with the mailbox.
*
- * Note: This member is currently only supported in Outlook 2016 for Mac, build 16.9.1212 and greater.
+ * **Note**: This member is currently only supported in Outlook 2016 for Mac, build 16.9.1212 and greater.
*
* [Api set: Mailbox 1.6]
*
diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts
index d53bdedb79..caafa47822 100644
--- a/types/office-js/index.d.ts
+++ b/types/office-js/index.d.ts
@@ -20,7 +20,7 @@ declare namespace Office {
*/
var Promise: IPromiseConstructor;
- // Note: this is a copy of the PromiseConstructor object from
+ // **Note**: this is a copy of the PromiseConstructor object from
// https://github.com/Microsoft/TypeScript/blob/master/lib/lib.es2015.promise.d.ts
// It is necessary so that even with targeting "ES5" and not specifying any libs,
// developers will still get IntelliSense for "Office.Promise" just as they would with a regular Promise.
@@ -628,7 +628,7 @@ declare namespace Office {
* You access the AsyncResult object in the function passed as the argument to the callback parameter of an "Async" method, such as the
* `getSelectedDataAsync` and `setSelectedDataAsync` methods of the {@link Office.Document | Document} object.
*
- * Note: What the value property returns for a particular "Async" method varies depending on the purpose and context of that method.
+ * **Note**: What the value property returns for a particular "Async" method varies depending on the purpose and context of that method.
* To determine what is returned by the value property for an "Async" method, refer to the "Callback value" section of the method's topic.
*
* **Support details**
@@ -1446,7 +1446,7 @@ declare namespace Office {
/**
* Specifies a table of sample data displayed in the prompt UI as an example of the kinds of fields (columns) that can be bound by your add-in.
* The headers provided in the TableData object specify the labels used in the field selection UI.
- * Note: This parameter is used only in add-ins for Access. It is ignored if provided when calling the method in an add-in for Excel.
+ * **Note**: This parameter is used only in add-ins for Access. It is ignored if provided when calling the method in an add-in for Excel.
*/
sampleData?: Office.TableData
/**
@@ -1781,43 +1781,43 @@ declare namespace Office {
* Return or set data as tabular data with no headers. Data is returned or set as an array of arrays containing one-dimensional runs of
* characters. For example, three rows of string values in two columns would be: [["R1C1", "R1C2"], ["R2C1", "R2C2"], ["R3C1", "R3C2"]].
*
- * Note: Only applies to data in Excel and Word.
+ * **Note**: Only applies to data in Excel and Word.
*/
Matrix,
/**
* Return or set data as tabular data with optional headers. Data is returned or set as an array of arrays with optional headers.
*
- * Note: Only applies to data in Access, Excel, and Word.
+ * **Note**: Only applies to data in Access, Excel, and Word.
*/
Table,
/**
* Return or set data as HTML.
*
- * Note: Only applies to data in add-ins for Word and Outlook add-ins for Outlook (compose mode).
+ * **Note**: Only applies to data in add-ins for Word and Outlook add-ins for Outlook (compose mode).
*/
Html,
/**
* Return or set data as Office Open XML.
*
- * Note: Only applies to data in Word.
+ * **Note**: Only applies to data in Word.
*/
Ooxml,
/**
* Return a JSON object that contains an array of the ids, titles, and indexes of the selected slides. For example,
* `{"slides":[{"id":257,"title":"Slide 2","index":2},{"id":256,"title":"Slide 1","index":1}]}` for a selection of two slides.
*
- * Note: Only applies to data in PowerPoint when calling the {@link Office.Document | Document}.getSelectedData method to get the current
+ * **Note**: Only applies to data in PowerPoint when calling the {@link Office.Document | Document}.getSelectedData method to get the current
* slide or selected range of slides.
*/
SlideRange,
/**
* Data is returned or set as an image stream.
- * Note: Only applies to data in Excel, Word, and PowerPoint.
+ * **Note**: Only applies to data in Excel, Word, and PowerPoint.
*/
Image,
/**
* Data is returned or set as XML data containing an SVG image.
- * Note: Only applies to data in Excel, Word, and PowerPoint.
+ * **Note**: Only applies to data in Excel, Word, and PowerPoint.
*/
XmlSvg
}
@@ -2523,7 +2523,7 @@ declare namespace Office {
*
*
* | An {@link Office.TableData} object, and the shape of the table matches the bound table. |
- * The specified set of rows and/or headers are written, if no other data in surrounding cells will be overwritten. Note: If you specify formulas in the TableData object you pass for the *data* parameter, you might not get the results you expect due to the "calculated columns" feature of Excel, which automatically duplicates formulas within a column. To work around this when you want to write *data* that contains formulas to a bound table, try specifying the data as an array of arrays (instead of a TableData object), and specify the *coercionType* as Microsoft.Office.Matrix or "matrix". |
+ * The specified set of rows and/or headers are written, if no other data in surrounding cells will be overwritten. **Note**: If you specify formulas in the TableData object you pass for the *data* parameter, you might not get the results you expect due to the "calculated columns" feature of Excel, which automatically duplicates formulas within a column. To work around this when you want to write *data* that contains formulas to a bound table, try specifying the data as an array of arrays (instead of a TableData object), and specify the *coercionType* as Microsoft.Office.Matrix or "matrix". |
*
*
*
@@ -2654,7 +2654,7 @@ declare namespace Office {
*
*
* | An {@link Office.TableData} object, and the shape of the table matches the bound table. |
- * The specified set of rows and/or headers are written, if no other data in surrounding cells will be overwritten. Note: If you specify formulas in the TableData object you pass for the *data* parameter, you might not get the results you expect due to the "calculated columns" feature of Excel, which automatically duplicates formulas within a column. To work around this when you want to write *data* that contains formulas to a bound table, try specifying the data as an array of arrays (instead of a TableData object), and specify the *coercionType* as Microsoft.Office.Matrix or "matrix". |
+ * The specified set of rows and/or headers are written, if no other data in surrounding cells will be overwritten. **Note**: If you specify formulas in the TableData object you pass for the *data* parameter, you might not get the results you expect due to the "calculated columns" feature of Excel, which automatically duplicates formulas within a column. To work around this when you want to write *data* that contains formulas to a bound table, try specifying the data as an array of arrays (instead of a TableData object), and specify the *coercionType* as Microsoft.Office.Matrix or "matrix". |
*
*
*
@@ -2825,7 +2825,7 @@ declare namespace Office {
* By default, adding a table in Excel assigns the name "Table1" for the first table you add, "Table2" for the second table you add, and so on.
* To assign a meaningful name for a table in the Excel UI, use the Table Name property on the Table Tools | Design tab of the ribbon.
*
- * Note: In Excel, when specifying a table as a named item, you must fully qualify the name to include the worksheet name in the name of
+ * **Note**: In Excel, when specifying a table as a named item, you must fully qualify the name to include the worksheet name in the name of
* the table in this format: "Sheet1!Table1"
*
* For Word, the itemName parameter refers to the Title property of a Rich Text content control. (You can't bind to content controls other
@@ -2835,7 +2835,7 @@ declare namespace Office {
* control from the Controls group on the Developer tab of the ribbon, use the Properties command in the Controls group to display the Content
* Control Properties dialog box. Then set the Title property of the content control to the name you want to reference from your code.
*
- * Note: In Word, if there are multiple Rich Text content controls with the same Title property value (name), and you try to bind to one
+ * **Note**: In Word, if there are multiple Rich Text content controls with the same Title property value (name), and you try to bind to one
* these content controls with this method (by specifying its name as the itemName parameter), the operation will fail.
*
* **Support details**
@@ -2871,7 +2871,7 @@ declare namespace Office {
* By default, adding a table in Excel assigns the name "Table1" for the first table you add, "Table2" for the second table you add, and so on.
* To assign a meaningful name for a table in the Excel UI, use the Table Name property on the Table Tools | Design tab of the ribbon.
*
- * Note: In Excel, when specifying a table as a named item, you must fully qualify the name to include the worksheet name in the name of
+ * **Note**: In Excel, when specifying a table as a named item, you must fully qualify the name to include the worksheet name in the name of
* the table in this format: "Sheet1!Table1"
*
* For Word, the itemName parameter refers to the Title property of a Rich Text content control. (You can't bind to content controls other
@@ -2881,7 +2881,7 @@ declare namespace Office {
* control from the Controls group on the Developer tab of the ribbon, use the Properties command in the Controls group to display the Content
* Control Properties dialog box. Then set the Title property of the content control to the name you want to reference from your code.
*
- * Note: In Word, if there are multiple Rich Text content controls with the same Title property value (name), and you try to bind to one
+ * **Note**: In Word, if there are multiple Rich Text content controls with the same Title property value (name), and you try to bind to one
* these content controls with this method (by specifying its name as the itemName parameter), the operation will fail.
*
* **Support details**
@@ -4542,7 +4542,7 @@ declare namespace Office {
*
* | Word | If there is no selection and the insertion point is at a valid location, the specified `data` is inserted at the insertion point | If `data` is a string, the specified text is inserted. |
* | | If `data` is an array of arrays ("matrix") or a TableData object, a new Word table is inserted. |
- * | | If `data` is HTML, the specified HTML is inserted. (Important: If any of the HTML you insert is invalid, Word won't raise an error. Word will insert as much of the HTML as it can and omits any invalid data). |
+ * | | If `data` is HTML, the specified HTML is inserted. (**Important**: If any of the HTML you insert is invalid, Word won't raise an error. Word will insert as much of the HTML as it can and omits any invalid data). |
* | | If `data` is Office Open XML, the specified XML is inserted. |
* | | If `data` is a base64 encoded image stream, the specified image is inserted. |
* | If there is a selection | It will be replaced with the specified `data` following the same rules as above. |
@@ -4659,7 +4659,7 @@ declare namespace Office {
*
* | Word | If there is no selection and the insertion point is at a valid location, the specified `data` is inserted at the insertion point | If `data` is a string, the specified text is inserted. |
* | | If `data` is an array of arrays ("matrix") or a TableData object, a new Word table is inserted. |
- * | | If `data` is HTML, the specified HTML is inserted. (Important: If any of the HTML you insert is invalid, Word won't raise an error. Word will insert as much of the HTML as it can and omits any invalid data). |
+ * | | If `data` is HTML, the specified HTML is inserted. (**Important**: If any of the HTML you insert is invalid, Word won't raise an error. Word will insert as much of the HTML as it can and omits any invalid data). |
* | | If `data` is Office Open XML, the specified XML is inserted. |
* | | If `data` is a base64 encoded image stream, the specified image is inserted. |
* | If there is a selection | It will be replaced with the specified `data` following the same rules as above. |
@@ -5151,7 +5151,7 @@ declare namespace Office {
/**
* Project documents only. Get the maximum index of the collection of resources in the current project.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
@@ -5177,7 +5177,7 @@ declare namespace Office {
/**
* Project documents only. Get the maximum index of the collection of resources in the current project.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
* The `value` property of the result is the highest index number in the current project's resource collection.
@@ -5202,7 +5202,7 @@ declare namespace Office {
/**
* Project documents only. Get the maximum index of the collection of tasks in the current project.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
@@ -5228,7 +5228,7 @@ declare namespace Office {
/**
* Project documents only. Get the maximum index of the collection of tasks in the current project.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
* The `value` property of the result is the highest index number in the current project's task collection.
@@ -5253,7 +5253,7 @@ declare namespace Office {
/**
* Project documents only. Get the GUID of the resource that has the specified index in the resource collection.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param resourceIndex The index of the resource in the collection of resources for the project.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -5280,7 +5280,7 @@ declare namespace Office {
/**
* Project documents only. Get the GUID of the resource that has the specified index in the resource collection.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param resourceIndex The index of the resource in the collection of resources for the project.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
@@ -5306,7 +5306,7 @@ declare namespace Office {
/**
* Project documents only. Get the GUID of the task that has the specified index in the task collection.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param taskIndex The index of the task in the collection of tasks for the project.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -5333,7 +5333,7 @@ declare namespace Office {
/**
* Project documents only. Get the GUID of the task that has the specified index in the task collection.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param taskIndex The index of the task in the collection of tasks for the project.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
@@ -5359,7 +5359,7 @@ declare namespace Office {
/**
* Project documents only. Set resource field for specified resource Id.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param resourceId Either a string or value of the Resource Id.
* @param fieldId Resource Fields.
@@ -5387,7 +5387,7 @@ declare namespace Office {
/**
* Project documents only. Set resource field for specified resource Id.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param resourceId Either a string or value of the Resource Id.
* @param fieldId Resource Fields.
@@ -5414,7 +5414,7 @@ declare namespace Office {
/**
* Project documents only. Set task field for specified task Id.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param taskId Either a string or value of the Task Id.
* @param fieldId Task Fields.
@@ -5442,7 +5442,7 @@ declare namespace Office {
/**
* Project documents only. Set task field for specified task Id.
*
- * Important: This API works only in Project 2016 on Windows desktop.
+ * **Important**: This API works only in Project 2016 on Windows desktop.
*
* @param taskId Either a string or value of the Task Id.
* @param fieldId Task Fields.
@@ -5662,7 +5662,7 @@ declare namespace Office {
/**
* Adds an event handler for the settingsChanged event.
*
- * Important: Your add-in's code can register a handler for the settingsChanged event when the add-in is running with any Excel client, but
+ * **Important**: Your add-in's code can register a handler for the settingsChanged event when the add-in is running with any Excel client, but
* the event will fire only when the add-in is loaded with a spreadsheet that is opened in Excel Online, and more than one user is editing the
* spreadsheet (co-authoring). Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios.
*
@@ -5719,7 +5719,7 @@ declare namespace Office {
/**
* Adds an event handler for the settingsChanged event.
*
- * Important: Your add-in's code can register a handler for the settingsChanged event when the add-in is running with any Excel client, but
+ * **Important**: Your add-in's code can register a handler for the settingsChanged event when the add-in is running with any Excel client, but
* the event will fire only when the add-in is loaded with a spreadsheet that is opened in Excel Online, and more than one user is editing the
* spreadsheet (co-authoring). Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios.
*
@@ -5862,7 +5862,7 @@ declare namespace Office {
/**
* Removes the specified setting.
*
- * Important: Be aware that the Settings.remove method affects only the in-memory copy of the settings property bag. To persist the removal of
+ * **Important**: Be aware that the Settings.remove method affects only the in-memory copy of the settings property bag. To persist the removal of
* the specified setting in the document, at some point after calling the Settings.remove method and before the add-in is closed, you must
* call the Settings.saveAsync method.
*
@@ -5970,7 +5970,7 @@ declare namespace Office {
* set and get methods to work with the in-memory copy of the settings property bag. When you want to persist the settings so that they are
* available the next time the add-in is used, use the saveAsync method.
*
- * Note: The saveAsync method persists the in-memory settings property bag into the document file. However, the changes to the document file
+ * **Note**: The saveAsync method persists the in-memory settings property bag into the document file. However, the changes to the document file
* itself are saved only when the user (or AutoRecover setting) saves the document to the file system. The refreshAsync method is only useful
* in coauthoring scenarios when other instances of the same add-in might change the settings and those changes should be made available to
* all instances.
@@ -6027,7 +6027,7 @@ declare namespace Office {
* set and get methods to work with the in-memory copy of the settings property bag. When you want to persist the settings so that they are
* available the next time the add-in is used, use the saveAsync method.
*
- * Note: The saveAsync method persists the in-memory settings property bag into the document file. However, the changes to the document file
+ * **Note**: The saveAsync method persists the in-memory settings property bag into the document file. However, the changes to the document file
* itself are saved only when the user (or AutoRecover setting) saves the document to the file system. The refreshAsync method is only useful
* in coauthoring scenarios when other instances of the same add-in might change the settings and those changes should be made available to
* all instances.
@@ -6078,7 +6078,7 @@ declare namespace Office {
/**
* Sets or creates the specified setting.
*
- * Important: Be aware that the Settings.set method affects only the in-memory copy of the settings property bag.
+ * **Important**: Be aware that the Settings.set method affects only the in-memory copy of the settings property bag.
* To make sure that additions or changes to settings will be available to your add-in the next time the document is opened, at some point
* after calling the Settings.set method and before the add-in is closed, you must call the Settings.saveAsync method to persist settings in
* the document.
@@ -6128,7 +6128,7 @@ declare namespace Office {
* The settingsChanged event was designed to let you to handle potential conflicts when two or more users are
* attempting to save settings at the same time when your add-in is used in a shared (co-authored) document.
*
- * **Important:** Your add-in's code can register a handler for the settingsChanged event when the add-in
+ * **Important**: Your add-in's code can register a handler for the settingsChanged event when the add-in
* is running with any Excel client, but the event will fire only when the add-in is loaded with a spreadsheet
* that is opened in Excel Online, and more than one user is editing the spreadsheet (co-authoring).
* Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios.
@@ -10541,7 +10541,7 @@ declare namespace Office {
/**
* Represents an attachment on an item from the server. Read mode only.
*
- * An array of AttachmentDetail objects is returned as the attachments property of an Appointment or Message object.
+ * An array of **AttachmentDetails** objects is returned as the attachments property of an appointment or message item.
*
* [Api set: Mailbox 1.0]
*
@@ -11741,16 +11741,18 @@ declare namespace Office {
/**
* The subclass of {@link Office.Item} dealing with appointments.
*
- * Important: This is an internal Outlook object, not directly exposed through existing interfaces.
- * You should treat this as a mode of Office.context.mailbox.item. Refer to the Object Model pages for more information.
+ * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
+ * You should treat this as a mode of Office.context.mailbox.item. Refer to the
+ * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information.
*/
interface Appointment extends Item {
}
/**
* The appointment organizer mode of {@link Office.Item | Office.context.mailbox.item}.
*
- * Important: This is an internal Outlook object, not directly exposed through existing interfaces.
- * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the Object Model pages for more information.
+ * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
+ * You should treat this as a mode of Office.context.mailbox.item. Refer to the
+ * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information.
*/
interface AppointmentCompose extends Appointment, ItemCompose {
/**
@@ -11765,32 +11767,6 @@ declare namespace Office {
* | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Appointment Organizer |
*/
body: Body;
- /**
- * Gets the date and time that an item was created. Read mode only.
- *
- * [Api set: Mailbox 1.0]
- *
- * @remarks
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level} | ReadItem |
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Appointment Organizer |
- */
- dateTimeCreated: Date;
- /**
- * Gets the date and time that an item was last modified. Read mode only.
- *
- * [Api set: Mailbox 1.0]
- *
- * @remarks
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level} | ReadItem |
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Appointment Organizer |
- *
- * Note: This member is not supported in Outlook for iOS or Outlook for Android.
- */
- dateTimeModified: Date;
/**
* Gets or sets the date and time that the appointment is to end.
*
@@ -11904,9 +11880,9 @@ declare namespace Office {
* The recurrence property returns a recurrence object for recurring appointments or meetings requests if an item is a series or an instance
* in a series. `null` is returned for single appointments and meeting requests of single appointments.
*
- * Note: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request.
+ * **Note**: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request.
*
- * Note: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single
+ * **Note**: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single
* appointment and NOT a part of a series.
*
* [Api set: Mailbox 1.7]
@@ -11938,7 +11914,7 @@ declare namespace Office {
* In OWA and Outlook, the seriesId returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to.
* However, in iOS and Android, the seriesId returns the REST ID of the parent item.
*
- * Note: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier.
+ * **Note**: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier.
* The seriesId property is not identical to the Outlook IDs used by the Outlook REST API.
* Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId.
* For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}.
@@ -12295,7 +12271,7 @@ declare namespace Office {
*
* In the Outlook desktop client, if the message is an inline reply, the close method has no effect.
*
- * Note: In Outlook on the web, if the item is an appointment and it has previously been saved using saveAsync, the user is prompted to save,
+ * **Note**: In Outlook on the web, if the item is an appointment and it has previously been saved using saveAsync, the user is prompted to save,
* discard, or cancel even if no changes have occurred since the item was last saved.
*
* [Api set: Mailbox 1.3]
@@ -12330,7 +12306,7 @@ declare namespace Office {
/**
* Gets initialization data passed when the add-in is activated by an actionable message.
*
- * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web for Office 365.
+ * **Note**: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web for Office 365.
*
* [Api set: Mailbox Preview]
*
@@ -12590,11 +12566,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -12634,11 +12610,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -12667,11 +12643,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -12701,11 +12677,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -12842,8 +12818,9 @@ declare namespace Office {
/**
* The appointment attendee mode of {@link Office.Item | Office.context.mailbox.item}.
*
- * Important: This is an internal Outlook object, not directly exposed through existing interfaces.
- * You should treat this as a mode of 'Office.context.mailbox.item'. Refer to the Object Model pages for more information.
+ * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
+ * You should treat this as a mode of Office.context.mailbox.item. Refer to the
+ * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information.
*/
interface AppointmentRead extends Appointment, ItemRead {
/**
@@ -12857,7 +12834,7 @@ declare namespace Office {
*
* | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Appointment Attendee |
*
- * Note: Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned. For more information, see
+ * **Note**: Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned. For more information, see
* {@link https://support.office.com/article/Blocked-attachments-in-Outlook-434752E1-02D3-4E90-9124-8B81E49A8519 | Blocked attachments in Outlook}.
*
*/
@@ -12875,7 +12852,7 @@ declare namespace Office {
*/
body: Body;
/**
- * Gets the date and time that an item was created. Read mode only.
+ * Gets the date and time that an item was created.
*
* [Api set: Mailbox 1.0]
*
@@ -12887,7 +12864,7 @@ declare namespace Office {
*/
dateTimeCreated: Date;
/**
- * Gets the date and time that an item was last modified. Read mode only.
+ * Gets the date and time that an item was last modified.
*
* [Api set: Mailbox 1.0]
*
@@ -12897,7 +12874,7 @@ declare namespace Office {
*
* | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Appointment Attendee |
*
- * Note: This member is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This member is not supported in Outlook for iOS or Outlook for Android.
*/
dateTimeModified: Date;
/**
@@ -12985,7 +12962,7 @@ declare namespace Office {
* If an item identifier is required, the saveAsync method can be used to save the item to the store, which will return the item identifier
* in the asyncResult.value parameter in the callback function.
*
- * Note: The identifier returned by the itemId property is the same as the Exchange Web Services item identifier.
+ * **Note**: The identifier returned by the itemId property is the same as the Exchange Web Services item identifier.
* The itemId property is not identical to the Outlook Entry ID or the ID used by the Outlook REST API.
* Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId.
* For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api#get-the-item-id | Use the Outlook REST APIs from an Outlook add-in}.
@@ -13087,9 +13064,9 @@ declare namespace Office {
* The recurrence property returns a recurrence object for recurring appointments or meetings requests if an item is a series or an instance
* in a series. `null` is returned for single appointments and meeting requests of single appointments.
*
- * Note: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request.
+ * **Note**: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request.
*
- * Note: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single
+ * **Note**: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single
* appointment and NOT a part of a series.
*
* [Api set: Mailbox 1.7]
@@ -13137,7 +13114,7 @@ declare namespace Office {
* In OWA and Outlook, the seriesId returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to.
* However, in iOS and Android, the seriesId returns the REST ID of the parent item.
*
- * Note: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier.
+ * **Note**: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier.
* The seriesId property is not identical to the Outlook IDs used by the Outlook REST API. Before making REST API calls using this value, it
* should be converted using Office.context.mailbox.convertToRestId.
* For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}.
@@ -13232,7 +13209,7 @@ declare namespace Office {
* attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI.
* If this isn't possible, then no error message is thrown.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -13257,7 +13234,7 @@ declare namespace Office {
* attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI.
* If this isn't possible, then no error message is thrown.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -13275,7 +13252,7 @@ declare namespace Office {
/**
* Gets initialization data passed when the add-in is {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}.
*
- * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
+ * **Note**: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
* for Office 365.
*
* [Api set: Mailbox Preview]
@@ -13304,7 +13281,7 @@ declare namespace Office {
/**
* Gets initialization data passed when the add-in is {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}.
*
- * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web for Office 365.
+ * **Note**: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web for Office 365.
*
* [Api set: Mailbox Preview]
*
@@ -13326,7 +13303,7 @@ declare namespace Office {
/**
* Gets the entities found in the selected item's body.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -13340,7 +13317,7 @@ declare namespace Office {
/**
* Gets an array of all the entities of the specified entity type found in the selected item's body.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -13408,7 +13385,7 @@ declare namespace Office {
* The getFilteredEntitiesByName method returns the entities that match the regular expression defined in the ItemHasKnownEntity rule element
* in the manifest XML file with the specified FilterName element value.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -13438,7 +13415,7 @@ declare namespace Office {
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
* Instead, use the Body.getAsync method to retrieve the entire body.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -13464,7 +13441,7 @@ declare namespace Office {
* and should not attempt to return the entire body of the item.
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -13483,7 +13460,7 @@ declare namespace Office {
/**
* Gets the entities found in a highlighted match a user has selected. Highlighted matches apply to contextual add-ins.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.6]
*
@@ -13510,7 +13487,7 @@ declare namespace Office {
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
* Instead, use the Body.getAsync method to retrieve the entire body.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.6]
*
@@ -13622,32 +13599,6 @@ declare namespace Office {
* | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Compose or read |
*/
body: Body;
- /**
- * Gets the date and time that an item was created. Read mode only.
- *
- * [Api set: Mailbox 1.0]
- *
- * @remarks
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level} | ReadItem |
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Read |
- */
- dateTimeCreated: Date;
- /**
- * Gets the date and time that an item was last modified. Read mode only.
- *
- * [Api set: Mailbox 1.0]
- *
- * @remarks
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level} | ReadItem |
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Read |
- *
- * Note: This member is not supported in Outlook for iOS or Outlook for Android.
- */
- dateTimeModified: Date;
/**
* Gets the type of item that an instance represents.
*
@@ -13676,36 +13627,13 @@ declare namespace Office {
*/
notificationMessages: NotificationMessages;
- /**
- * Gets or sets the recurrence pattern of an appointment. Gets the recurrence pattern of a meeting request.
- * Read and compose modes for appointment items. Read mode for meeting request items.
- *
- * The recurrence property returns a recurrence object for recurring appointments or meetings requests if an item is a series or an instance
- * in a series. `null` is returned for single appointments and meeting requests of single appointments.
- * `undefined` is returned for messages that are not meeting requests.
- *
- * Note: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request.
- *
- * Note: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single appointment
- * and NOT a part of a series.
- *
- * [Api set: Mailbox 1.7]
- *
- * @remarks
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level} | ReadItem |
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Compose or read |
- */
- recurrence: Recurrence;
-
/**
* Gets the id of the series that an instance belongs to.
*
* In OWA and Outlook, the seriesId returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to.
* However, in iOS and Android, the seriesId returns the REST ID of the parent item.
*
- * Note: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier.
+ * **Note**: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier.
* The seriesId property is not identical to the Outlook IDs used by the Outlook REST API.
* Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId.
* For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}.
@@ -13774,7 +13702,7 @@ declare namespace Office {
addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult) => void): void;
/**
- * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
+ * Gets an attachment from a message or appointment and returns it as an **AttachmentContent** object.
*
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use
* the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or
@@ -13806,7 +13734,7 @@ declare namespace Office {
/**
* Gets initialization data passed when the add-in is {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}.
*
- * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
+ * **Note**: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
* for Office 365.
*
* [Api set: Mailbox Preview]
@@ -13950,8 +13878,9 @@ declare namespace Office {
/**
* The compose mode of {@link Office.Item | Office.context.mailbox.item}.
*
- * Important: This is an internal Outlook object, not directly exposed through existing interfaces.
- * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the Object Model pages for more information.
+ * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
+ * You should treat this as a mode of Office.context.mailbox.item. Refer to the
+ * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information.
*/
interface ItemCompose extends Item {
/**
@@ -14237,7 +14166,7 @@ declare namespace Office {
*
* In the Outlook desktop client, if the message is an inline reply, the close method has no effect.
*
- * Note: In Outlook on the web, if the item is an appointment and it has previously been saved using saveAsync, the user is prompted to save,
+ * **Note**: In Outlook on the web, if the item is an appointment and it has previously been saved using saveAsync, the user is prompted to save,
* discard, or cancel even if no changes have occurred since the item was last saved.
*
* [Api set: Mailbox 1.3]
@@ -14272,7 +14201,7 @@ declare namespace Office {
/**
* Gets initialization data passed when the add-in is activated by an actionable message.
*
- * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web for Office 365.
+ * **Note**: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web for Office 365.
*
* [Api set: Mailbox Preview]
*
@@ -14467,11 +14396,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -14513,11 +14442,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -14546,11 +14475,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -14581,11 +14510,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -14724,8 +14653,9 @@ declare namespace Office {
/**
* The read mode of {@link Office.Item | Office.context.mailbox.item}.
*
- * Important: This is an internal Outlook object, not directly exposed through existing interfaces.
- * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the Object Model pages for more information.
+ * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
+ * You should treat this as a mode of Office.context.mailbox.item. Refer to the
+ * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information.
*/
interface ItemRead extends Item {
/**
@@ -14738,7 +14668,7 @@ declare namespace Office {
*
* | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Read |
*
- * Note: Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned.
+ * **Note**: Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned.
* For more information, see
* {@link https://support.office.com/article/Blocked-attachments-in-Outlook-434752E1-02D3-4E90-9124-8B81E49A8519 | Blocked attachments in Outlook}.
*
@@ -14788,7 +14718,7 @@ declare namespace Office {
* If an item identifier is required, the saveAsync method can be used to save the item to the store, which will return the item identifier
* in the asyncResult.value parameter in the callback function.
*
- * Note: The identifier returned by the itemId property is the same as the Exchange Web Services item identifier.
+ * **Note**: The identifier returned by the itemId property is the same as the Exchange Web Services item identifier.
* The itemId property is not identical to the Outlook Entry ID or the ID used by the Outlook REST API.
* Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId.
* For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api#get-the-item-id | Use the Outlook REST APIs from an Outlook add-in}.
@@ -14845,7 +14775,7 @@ declare namespace Office {
* attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI.
* If this isn't possible, then no error message is thrown.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -14870,7 +14800,7 @@ declare namespace Office {
* attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI.
* If this isn't possible, then no error message is thrown.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -14888,7 +14818,7 @@ declare namespace Office {
/**
* Gets initialization data passed when the add-in is {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}.
*
- * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
+ * **Note**: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
* for Office 365.
*
* [Api set: Mailbox Preview]
@@ -14917,7 +14847,7 @@ declare namespace Office {
/**
* Gets initialization data passed when the add-in is {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}.
*
- * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
+ * **Note**: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
* for Office 365.
*
* [Api set: Mailbox Preview]
@@ -14940,7 +14870,7 @@ declare namespace Office {
/**
* Gets the entities found in the selected item's body.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -14954,7 +14884,7 @@ declare namespace Office {
/**
* Gets an array of all the entities of the specified entity type found in the selected item's body.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -15023,7 +14953,7 @@ declare namespace Office {
* The getFilteredEntitiesByName method returns the entities that match the regular expression defined in the ItemHasKnownEntity rule element
* in the manifest XML file with the specified FilterName element value.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -15053,7 +14983,7 @@ declare namespace Office {
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
* Instead, use the Body.getAsync method to retrieve the entire body.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -15079,7 +15009,7 @@ declare namespace Office {
* and should not attempt to return the entire body of the item.
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -15098,7 +15028,7 @@ declare namespace Office {
/**
* Gets the entities found in a highlighted match a user has selected. Highlighted matches apply to contextual add-ins.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.6]
*
@@ -15123,7 +15053,7 @@ declare namespace Office {
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
* Instead, use the Body.getAsync method to retrieve the entire body.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.6]
*
@@ -15143,8 +15073,9 @@ declare namespace Office {
/**
* A subclass of {@link Office.Item} for messages.
*
- * Important: This is an internal Outlook object, not directly exposed through existing interfaces.
- * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the Object Model pages for more information.
+ * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
+ * You should treat this as a mode of Office.context.mailbox.item. Refer to the
+ * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information.
*/
interface Message extends Item {
/**
@@ -15171,8 +15102,9 @@ declare namespace Office {
/**
* The message compose mode of {@link Office.Item | Office.context.mailbox.item}.
*
- * Important: This is an internal Outlook object, not directly exposed through existing interfaces.
- * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the Object Model pages for more information.
+ * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
+ * You should treat this as a mode of Office.context.mailbox.item. Refer to the
+ * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information.
*/
interface MessageCompose extends Message, ItemCompose {
/**
@@ -15234,32 +15166,6 @@ declare namespace Office {
* | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Message Compose |
*/
conversationId: string;
- /**
- * Gets the date and time that an item was created. Read mode only.
- *
- * [Api set: Mailbox 1.0]
- *
- * @remarks
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level} | ReadItem |
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Message Compose |
- */
- dateTimeCreated: Date;
- /**
- * Gets the date and time that an item was last modified. Read mode only.
- *
- * [Api set: Mailbox 1.0]
- *
- * @remarks
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level} | ReadItem |
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Message Compose |
- *
- * Note: This member is not supported in Outlook for iOS or Outlook for Android.
- */
- dateTimeModified: Date;
/**
* Gets the email address of the sender of a message.
*
@@ -15320,35 +15226,13 @@ declare namespace Office {
* | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Message Compose |
*/
notificationMessages: NotificationMessages;
- /**
- * Gets or sets the recurrence pattern of an appointment. Gets the recurrence pattern of a meeting request.
- * Read and compose modes for appointment items. Read mode for meeting request items.
- *
- * The recurrence property returns a recurrence object for recurring appointments or meetings requests if an item is a series or an instance
- * in a series. `null` is returned for single appointments and meeting requests of single appointments.
- * `undefined` is returned for messages that are not meeting requests.
- *
- * Note: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request.
- *
- * Note: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single appointment
- * and NOT a part of a series.
- *
- * [Api set: Mailbox 1.7]
- *
- * @remarks
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level} | ReadItem |
- *
- * | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Message Compose |
- */
- recurrence: Recurrence;
/**
* Gets the id of the series that an instance belongs to.
*
* In OWA and Outlook, the seriesId returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to.
* However, in iOS and Android, the seriesId returns the REST ID of the parent item.
*
- * Note: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier.
+ * **Note**: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier.
* The seriesId property is not identical to the Outlook IDs used by the Outlook REST API.
* Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId.
* For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}.
@@ -15708,7 +15592,7 @@ declare namespace Office {
*
* In the Outlook desktop client, if the message is an inline reply, the close method has no effect.
*
- * Note: In Outlook on the web, if the item is an appointment and it has previously been saved using saveAsync, the user is prompted to save,
+ * **Note**: In Outlook on the web, if the item is an appointment and it has previously been saved using saveAsync, the user is prompted to save,
* discard, or cancel even if no changes have occurred since the item was last saved.
*
* [Api set: Mailbox 1.3]
@@ -15743,7 +15627,7 @@ declare namespace Office {
/**
* Gets initialization data passed when the add-in is activated by an actionable message.
*
- * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
+ * **Note**: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
* for Office 365.
*
* [Api set: Mailbox Preview]
@@ -16007,11 +15891,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -16052,11 +15936,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -16084,11 +15968,11 @@ declare namespace Office {
* Since appointments have no draft state, if saveAsync is called on an appointment in compose mode, the item will be saved as a normal
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -16119,11 +16003,11 @@ declare namespace Office {
* appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
* Saving an existing appointment will send an update to added or removed attendees.
*
- * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
+ * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that
* when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
* Until the item is synced, using the itemId will return an error.
*
- * Note: The following clients have different behavior for saveAsync on appointments in compose mode:
+ * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode:
*
* - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error.
*
@@ -16259,8 +16143,9 @@ declare namespace Office {
/**
* The message read mode of {@link Office.Item | Office.context.mailbox.item}.
*
- * Important: This is an internal Outlook object, not directly exposed through existing interfaces.
- * You should treat this as a mode of Office.context.mailbox.item. Refer to the Object Model pages for more information.
+ * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
+ * You should treat this as a mode of Office.context.mailbox.item. Refer to the
+ * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information.
*/
interface MessageRead extends Message, ItemRead {
/**
@@ -16274,7 +16159,7 @@ declare namespace Office {
*
* | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Message Read |
*
- * Note: Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned.
+ * **Note**: Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned.
* For more information, see
* {@link https://support.office.com/article/Blocked-attachments-in-Outlook-434752E1-02D3-4E90-9124-8B81E49A8519 | Blocked attachments in Outlook}.
*
@@ -16328,7 +16213,7 @@ declare namespace Office {
*/
conversationId: string;
/**
- * Gets the date and time that an item was created. Read mode only.
+ * Gets the date and time that an item was created.
*
* [Api set: Mailbox 1.0]
*
@@ -16340,7 +16225,7 @@ declare namespace Office {
*/
dateTimeCreated: Date;
/**
- * Gets the date and time that an item was last modified. Read mode only.
+ * Gets the date and time that an item was last modified.
*
* [Api set: Mailbox 1.0]
*
@@ -16350,7 +16235,7 @@ declare namespace Office {
*
* | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Message Read |
*
- * Note: This member is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This member is not supported in Outlook for iOS or Outlook for Android.
*/
dateTimeModified: Date;
/**
@@ -16359,7 +16244,7 @@ declare namespace Office {
* The from and sender properties represent the same person unless the message is sent by a delegate.
* In that case, the from property represents the delegator, and the sender property represents the delegate.
*
- * Note: The recipientType property of the EmailAddressDetails object in the from property is undefined.
+ * **Note**: The recipientType property of the EmailAddressDetails object in the from property is undefined.
*
* The from property returns an EmailAddressDetails object.
*
@@ -16444,7 +16329,7 @@ declare namespace Office {
* If an item identifier is required, the saveAsync method can be used to save the item to the store, which will return the item identifier
* in the asyncResult.value parameter in the callback function.
*
- * Note: The identifier returned by the itemId property is the same as the Exchange Web Services item identifier.
+ * **Note**: The identifier returned by the itemId property is the same as the Exchange Web Services item identifier.
* The itemId property is not identical to the Outlook Entry ID or the ID used by the Outlook REST API.
* Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId.
* For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api#get-the-item-id | Use the Outlook REST APIs from an Outlook add-in}.
@@ -16509,9 +16394,9 @@ declare namespace Office {
* in a series. `null` is returned for single appointments and meeting requests of single appointments.
* `undefined` is returned for messages that are not meeting requests.
*
- * Note: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request.
+ * **Note**: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request.
*
- * Note: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single appointment
+ * **Note**: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single appointment
* and NOT a part of a series.
*
* [Api set: Mailbox 1.7]
@@ -16529,7 +16414,7 @@ declare namespace Office {
* In OWA and Outlook, the seriesId returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to.
* However, in iOS and Android, the seriesId returns the REST ID of the parent item.
*
- * Note: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier.
+ * **Note**: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier.
* The seriesId property is not identical to the Outlook IDs used by the Outlook REST API.
* Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId.
* For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}.
@@ -16552,7 +16437,7 @@ declare namespace Office {
* The from and sender properties represent the same person unless the message is sent by a delegate.
* In that case, the from property represents the delegator, and the sender property represents the delegate.
*
- * Note: The recipientType property of the EmailAddressDetails object in the sender property is undefined.
+ * **Note**: The recipientType property of the EmailAddressDetails object in the sender property is undefined.
*
* [Api set: Mailbox 1.0]
*
@@ -16657,7 +16542,7 @@ declare namespace Office {
* attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI.
* If this isn't possible, then no error message is thrown.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -16682,7 +16567,7 @@ declare namespace Office {
* attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI.
* If this isn't possible, then no error message is thrown.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -16701,7 +16586,7 @@ declare namespace Office {
* Gets initialization data passed when the add-in is
* {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}.
*
- * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
+ * **Note**: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web
* for Office 365.
*
* [Api set: Mailbox Preview]
@@ -16731,7 +16616,7 @@ declare namespace Office {
* Gets initialization data passed when the add-in is
* {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}.
*
- * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the
+ * **Note**: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the
* web for Office 365.
*
* [Api set: Mailbox Preview]
@@ -16754,7 +16639,7 @@ declare namespace Office {
/**
* Gets the entities found in the selected item's body.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -16768,7 +16653,7 @@ declare namespace Office {
/**
* Gets an array of all the entities of the specified entity type found in the selected item's body.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -16838,7 +16723,7 @@ declare namespace Office {
* The getFilteredEntitiesByName method returns the entities that match the regular expression defined in the ItemHasKnownEntity rule element
* in the manifest XML file with the specified FilterName element value.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -16868,7 +16753,7 @@ declare namespace Office {
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
* Instead, use the Body.getAsync method to retrieve the entire body.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -16894,7 +16779,7 @@ declare namespace Office {
* and should not attempt to return the entire body of the item.
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -16913,7 +16798,7 @@ declare namespace Office {
/**
* Gets the entities found in a highlighted match a user has selected. Highlighted matches apply to contextual add-ins.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.6]
*
@@ -16940,7 +16825,7 @@ declare namespace Office {
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
* Instead, use the Body.getAsync method to retrieve the entire body.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.6]
*
@@ -17278,7 +17163,7 @@ declare namespace Office {
*
* The ewsUrl value can be used by a remote service to make EWS calls to the user's mailbox. For example, you can create a remote service to {@link https://docs.microsoft.com/outlook/add-ins/get-attachments-of-an-outlook-item | get attachments from the selected item}.
*
- * Note: This member is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This member is not supported in Outlook for iOS or Outlook for Android.
*/
ewsUrl: string;
/**
@@ -17339,7 +17224,7 @@ declare namespace Office {
* Item IDs retrieved via a REST API (such as the Outlook Mail API or the Microsoft Graph) use a different format than the format used by
* Exchange Web Services (EWS). The convertToEwsId method converts a REST-formatted ID into the proper format for EWS.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.3]
*
@@ -17380,7 +17265,7 @@ declare namespace Office {
/**
* Converts an item ID formatted for EWS into REST format.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.3]
*
@@ -17431,7 +17316,7 @@ declare namespace Office {
* If the specified item identifier does not identify an existing appointment, a blank pane opens on the client computer or device, and
* no error message will be returned.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -17457,7 +17342,7 @@ declare namespace Office {
* Do not use the displayMessageForm with an itemId that represents an appointment. Use the displayAppointmentForm method to display
* an existing appointment, and displayNewAppointmentForm to display a form to create a new appointment.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -17486,7 +17371,7 @@ declare namespace Office {
*
* If any of the parameters exceed the specified size limits, or if an unknown parameter name is specified, an exception is thrown.
*
- * Note: This method is not supported in Outlook for iOS or Outlook for Android.
+ * **Note**: This method is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
@@ -17568,7 +17453,7 @@ declare namespace Office {
*
* The add-in should use the ewsUrl property to determine the correct URL to use when making EWS calls.
*
- * Note: It is recommended that add-ins use the REST APIs instead of Exchange Web Services whenever possible.
+ * **Note**: It is recommended that add-ins use the REST APIs instead of Exchange Web Services whenever possible.
*
* [Api set: Mailbox 1.5]
*
@@ -17690,13 +17575,13 @@ declare namespace Office {
* The XML result of the EWS call is provided as a string in the asyncResult.value property.
* If the result exceeds 1 MB in size, an error message is returned instead.
*
- * Note: This method is not supported in the following scenarios:
+ * **Note**: This method is not supported in the following scenarios:
*
* - In Outlook for iOS or Outlook for Android.
*
* - When the add-in is loaded in a Gmail mailbox.
*
- * Note: The server administrator must set OAuthAuthentication to true on the Client Access Server EWS directory to enable the
+ * **Note**: The server administrator must set OAuthAuthentication to true on the Client Access Server EWS directory to enable the
* makeEwsRequestAsync method to make EWS requests.
*
* *Version differences*
@@ -17779,7 +17664,7 @@ declare namespace Office {
/**
* Gets a string that was identified as a meeting suggestion.
*/
- meetingstring: string;
+ meetingString: string;
/**
* Gets the date and time that a suggested meeting is to begin.
*/
@@ -18577,7 +18462,7 @@ declare namespace Office {
/**
* Sets the recurrence pattern of an appointment series.
*
- * Note: setAsync should only be available for series items and not instance items.
+ * **Note**: setAsync should only be available for series items and not instance items.
*
* [Api set: Mailbox 1.7]
*
@@ -18604,7 +18489,7 @@ declare namespace Office {
/**
* Sets the recurrence pattern of an appointment series.
*
- * Note: setAsync should only be available for series items and not instance items.
+ * **Note**: setAsync should only be available for series items and not instance items.
*
* [Api set: Mailbox 1.7]
*
@@ -18746,7 +18631,7 @@ declare namespace Office {
*
* The RoamingSettings object is accessible via the roamingSettings property in the Office.context namespace.
*
- * Important: The RoamingSettings object is initialized from the persisted storage only when the add-in is first loaded.
+ * **Important**: The RoamingSettings object is initialized from the persisted storage only when the add-in is first loaded.
* For task panes, this means that it is only initialized when the task pane first opens.
* If the task pane navigates to another page or reloads the current page, the in-memory object is reset to its initial values, even if
* your add-in has persisted changes. The persisted changes will not be available until the task pane is closed and reopened.
@@ -19386,7 +19271,7 @@ declare namespace Office {
/**
* Gets the account type of the user associated with the mailbox.
*
- * Note: This member is currently only supported in Outlook 2016 for Mac, build 16.9.1212 and greater.
+ * **Note**: This member is currently only supported in Outlook 2016 for Mac, build 16.9.1212 and greater.
*
* [Api set: Mailbox 1.6]
*