mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-10-05 07:17:04 +00:00
[office-js] [office-js-preview] (Outlook) Add APIs missing from MessageRead (#40169)
This commit is contained in:
committed by
Nathan Shively-Sanders
parent
41b6c9f318
commit
4652a68fc0
Vendored
+125
-42
@@ -9512,6 +9512,11 @@ declare namespace Office {
|
||||
* To access the selected data from the callback method, call asyncResult.value.data.
|
||||
* To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject.
|
||||
*
|
||||
* **Note**: In Outlook on the web, the method returns the string "null" if no text is selected but the cursor is in the body.
|
||||
* To check for this situation, include code similar to the following:
|
||||
*
|
||||
* `var selectedText = (asyncResult.value.endPosition === asyncResult.value.startPosition) ? "" : asyncResult.value.data;`
|
||||
*
|
||||
* [Api set: Mailbox 1.2]
|
||||
*
|
||||
* @returns
|
||||
@@ -9539,6 +9544,11 @@ declare namespace Office {
|
||||
* To access the selected data from the callback method, call asyncResult.value.data.
|
||||
* To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject.
|
||||
*
|
||||
* **Note**: In Outlook on the web, the method returns the string "null" if no text is selected but the cursor is in the body.
|
||||
* To check for this situation, include code similar to the following:
|
||||
*
|
||||
* `var selectedText = (asyncResult.value.endPosition === asyncResult.value.startPosition) ? "" : asyncResult.value.data;`
|
||||
*
|
||||
* [Api set: Mailbox 1.2]
|
||||
*
|
||||
* @returns
|
||||
@@ -9833,7 +9843,7 @@ declare namespace Office {
|
||||
*
|
||||
* **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read
|
||||
*/
|
||||
body: string;
|
||||
body: Body | string;
|
||||
/**
|
||||
* Gets or sets the date and time that the appointment is to end.
|
||||
*
|
||||
@@ -9859,7 +9869,7 @@ declare namespace Office {
|
||||
*
|
||||
* **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read
|
||||
*/
|
||||
end: Date;
|
||||
end: Time | Date;
|
||||
/**
|
||||
* Gets or sets the location of an appointment.
|
||||
*
|
||||
@@ -9879,7 +9889,7 @@ declare namespace Office {
|
||||
*
|
||||
* **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read
|
||||
*/
|
||||
location: string;
|
||||
location: Location | string;
|
||||
/**
|
||||
* Provides access to the optional attendees of an event. The type of object and level of access depends on the mode of the current item.
|
||||
*
|
||||
@@ -9969,7 +9979,7 @@ declare namespace Office {
|
||||
*
|
||||
* **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read
|
||||
*/
|
||||
start: Date;
|
||||
start: Time | Date;
|
||||
/**
|
||||
* Gets or sets the description that appears in the subject field of an item.
|
||||
*
|
||||
@@ -9991,7 +10001,7 @@ declare namespace Office {
|
||||
*
|
||||
* **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read
|
||||
*/
|
||||
subject: string;
|
||||
subject: Subject | string;
|
||||
}
|
||||
/**
|
||||
* The appointment attendee mode of {@link Office.Item | Office.context.mailbox.item}.
|
||||
@@ -10137,13 +10147,15 @@ declare namespace Office {
|
||||
*/
|
||||
itemClass: string;
|
||||
/**
|
||||
* Gets the Exchange Web Services item identifier for the current item.
|
||||
* Gets the {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services item identifier}
|
||||
* for the current item.
|
||||
*
|
||||
* The itemId property is not available in compose mode.
|
||||
* 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
|
||||
* {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | 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}.
|
||||
@@ -11284,10 +11296,10 @@ declare namespace Office {
|
||||
color: MailboxEnums.CategoryColor | string;
|
||||
}
|
||||
/**
|
||||
* Represents a contact stored on the server. Read mode only.
|
||||
* Represents the details about a contact (similar to what's on a physical contact or business card) extracted from the item's body. Read mode only.
|
||||
*
|
||||
* The list of contacts associated with an email message or appointment is returned in the contacts property of the {@link Office.Entities | Entities} object
|
||||
* that is returned by the getEntities or getEntitiesByType method of the active item.
|
||||
* The list of contacts extracted from the body of an email message or appointment is returned in the contacts property of the
|
||||
* {@link Office.Entities | Entities} object returned by the getEntities or getEntitiesByType method of the current item.
|
||||
*
|
||||
* [Api set: Mailbox 1.0]
|
||||
*
|
||||
@@ -12622,6 +12634,11 @@ declare namespace Office {
|
||||
* To access the selected data from the callback method, call asyncResult.value.data.
|
||||
* To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject.
|
||||
*
|
||||
* **Note**: In Outlook on the web, the method returns the string "null" if no text is selected but the cursor is in the body.
|
||||
* To check for this situation, include code similar to the following:
|
||||
*
|
||||
* `var selectedText = (asyncResult.value.endPosition === asyncResult.value.startPosition) ? "" : asyncResult.value.data;`
|
||||
*
|
||||
* [Api set: Mailbox 1.2]
|
||||
*
|
||||
* @returns
|
||||
@@ -12650,6 +12667,11 @@ declare namespace Office {
|
||||
* To access the selected data from the callback method, call asyncResult.value.data.
|
||||
* To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject.
|
||||
*
|
||||
* **Note**: In Outlook on the web, the method returns the string "null" if no text is selected but the cursor is in the body.
|
||||
* To check for this situation, include code similar to the following:
|
||||
*
|
||||
* `var selectedText = (asyncResult.value.endPosition === asyncResult.value.startPosition) ? "" : asyncResult.value.data;`
|
||||
*
|
||||
* [Api set: Mailbox 1.2]
|
||||
*
|
||||
* @returns
|
||||
@@ -12926,13 +12948,15 @@ declare namespace Office {
|
||||
*/
|
||||
itemClass: string;
|
||||
/**
|
||||
* Gets the Exchange Web Services item identifier for the current item.
|
||||
* Gets the {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services item identifier}
|
||||
* for the current item.
|
||||
*
|
||||
* The itemId property is not available in compose mode.
|
||||
* 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
|
||||
* {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | 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}.
|
||||
@@ -14846,34 +14870,6 @@ declare namespace Office {
|
||||
* @beta
|
||||
*/
|
||||
getInitializationContextAsync(callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
|
||||
/**
|
||||
* Asynchronously returns selected data from the subject or body of a message.
|
||||
*
|
||||
* If there is no selection but the cursor is in the body or subject, the method returns null for the selected data.
|
||||
* If a field other than the body or subject is selected, the method returns the InvalidSelection error.
|
||||
*
|
||||
* To access the selected data from the callback method, call asyncResult.value.data.
|
||||
* To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject.
|
||||
*
|
||||
* [Api set: Mailbox 1.2]
|
||||
*
|
||||
* @returns
|
||||
* The selected data as a string with format determined by coercionType.
|
||||
*
|
||||
* @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
|
||||
*
|
||||
* @param coercionType - Requests a format for the data. If Text, the method returns the plain text as a string, removing any HTML tags present.
|
||||
* If HTML, the method returns the selected text, whether it is plaintext or HTML.
|
||||
* @param options - An object literal that contains one or more of the following properties.
|
||||
* asyncContext: Developers can provide any object they wish to access in the callback method.
|
||||
* @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of
|
||||
* type Office.AsyncResult.
|
||||
*/
|
||||
getSelectedDataAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<any>) => void): void;
|
||||
/**
|
||||
* Asynchronously gets the ID of a saved item.
|
||||
*
|
||||
@@ -14933,6 +14929,44 @@ declare namespace Office {
|
||||
* To access the selected data from the callback method, call asyncResult.value.data.
|
||||
* To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject.
|
||||
*
|
||||
* **Note**: In Outlook on the web, the method returns the string "null" if no text is selected but the cursor is in the body.
|
||||
* To check for this situation, include code similar to the following:
|
||||
*
|
||||
* `var selectedText = (asyncResult.value.endPosition === asyncResult.value.startPosition) ? "" : asyncResult.value.data;`
|
||||
*
|
||||
* [Api set: Mailbox 1.2]
|
||||
*
|
||||
* @returns
|
||||
* The selected data as a string with format determined by coercionType.
|
||||
*
|
||||
* @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
|
||||
*
|
||||
* @param coercionType - Requests a format for the data. If Text, the method returns the plain text as a string, removing any HTML tags present.
|
||||
* If HTML, the method returns the selected text, whether it is plaintext or HTML.
|
||||
* @param options - An object literal that contains one or more of the following properties.
|
||||
* asyncContext: Developers can provide any object they wish to access in the callback method.
|
||||
* @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of
|
||||
* type Office.AsyncResult.
|
||||
*/
|
||||
getSelectedDataAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<any>) => void): void;
|
||||
/**
|
||||
* Asynchronously returns selected data from the subject or body of a message.
|
||||
*
|
||||
* If there is no selection but the cursor is in the body or subject, the method returns null for the selected data.
|
||||
* If a field other than the body or subject is selected, the method returns the InvalidSelection error.
|
||||
*
|
||||
* To access the selected data from the callback method, call asyncResult.value.data.
|
||||
* To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject.
|
||||
*
|
||||
* **Note**: In Outlook on the web, the method returns the string "null" if no text is selected but the cursor is in the body.
|
||||
* To check for this situation, include code similar to the following:
|
||||
*
|
||||
* `var selectedText = (asyncResult.value.endPosition === asyncResult.value.startPosition) ? "" : asyncResult.value.data;`
|
||||
*
|
||||
* [Api set: Mailbox 1.2]
|
||||
*
|
||||
* @returns
|
||||
@@ -15316,6 +15350,24 @@ declare namespace Office {
|
||||
* **Note**: This member is not supported in Outlook on iOS or Android.
|
||||
*/
|
||||
dateTimeModified: Date;
|
||||
/**
|
||||
* Gets the date and time that the appointment is to end.
|
||||
*
|
||||
* The end property is a Date object expressed as a Coordinated Universal Time (UTC) date and time value.
|
||||
* You can use the convertToLocalClientTime method to convert the end property value to the client's local date and time.
|
||||
*
|
||||
* When you use the Time.setAsync method to set the end time, you should use the convertToUtcClientTime method to convert the local time on
|
||||
* the client to UTC for the server.
|
||||
*
|
||||
* [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 Read
|
||||
*/
|
||||
end: Date;
|
||||
/**
|
||||
* Gets the email address of the sender of a message.
|
||||
*
|
||||
@@ -15385,13 +15437,15 @@ declare namespace Office {
|
||||
*/
|
||||
itemClass: string;
|
||||
/**
|
||||
* Gets the Exchange Web Services item identifier for the current item.
|
||||
* Gets the {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services item identifier}
|
||||
* for the current item.
|
||||
*
|
||||
* The itemId property is not available in compose mode.
|
||||
* 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
|
||||
* {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | 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}.
|
||||
@@ -15420,6 +15474,20 @@ declare namespace Office {
|
||||
* **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read
|
||||
*/
|
||||
itemType: MailboxEnums.ItemType | string;
|
||||
/**
|
||||
* Gets the location of a meeting request.
|
||||
*
|
||||
* The location property returns a string that contains the location of the appointment.
|
||||
*
|
||||
* [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 Read
|
||||
*/
|
||||
location: string;
|
||||
/**
|
||||
* Gets the subject of an item, with all prefixes removed (including RE: and FWD:).
|
||||
*
|
||||
@@ -15510,6 +15578,21 @@ declare namespace Office {
|
||||
* **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read
|
||||
*/
|
||||
sender: EmailAddressDetails;
|
||||
/**
|
||||
* Gets the date and time that the appointment is to begin.
|
||||
*
|
||||
* The start property is a Date object expressed as a Coordinated Universal Time (UTC) date and time value.
|
||||
* You can use the convertToLocalClientTime method to convert the value to the client's local date and time.
|
||||
*
|
||||
* [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 Read
|
||||
*/
|
||||
start: Date;
|
||||
/**
|
||||
* Gets the description that appears in the subject field of an item.
|
||||
*
|
||||
|
||||
Vendored
+98
-15
@@ -9370,6 +9370,11 @@ declare namespace Office {
|
||||
* To access the selected data from the callback method, call asyncResult.value.data.
|
||||
* To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject.
|
||||
*
|
||||
* **Note**: In Outlook on the web, the method returns the string "null" if no text is selected but the cursor is in the body.
|
||||
* To check for this situation, include code similar to the following:
|
||||
*
|
||||
* `var selectedText = (asyncResult.value.endPosition === asyncResult.value.startPosition) ? "" : asyncResult.value.data;`
|
||||
*
|
||||
* [Api set: Mailbox 1.2]
|
||||
*
|
||||
* @returns
|
||||
@@ -9397,6 +9402,11 @@ declare namespace Office {
|
||||
* To access the selected data from the callback method, call asyncResult.value.data.
|
||||
* To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject.
|
||||
*
|
||||
* **Note**: In Outlook on the web, the method returns the string "null" if no text is selected but the cursor is in the body.
|
||||
* To check for this situation, include code similar to the following:
|
||||
*
|
||||
* `var selectedText = (asyncResult.value.endPosition === asyncResult.value.startPosition) ? "" : asyncResult.value.data;`
|
||||
*
|
||||
* [Api set: Mailbox 1.2]
|
||||
*
|
||||
* @returns
|
||||
@@ -9691,7 +9701,7 @@ declare namespace Office {
|
||||
*
|
||||
* **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read
|
||||
*/
|
||||
body: string;
|
||||
body: Body | string;
|
||||
/**
|
||||
* Gets or sets the date and time that the appointment is to end.
|
||||
*
|
||||
@@ -9717,7 +9727,7 @@ declare namespace Office {
|
||||
*
|
||||
* **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read
|
||||
*/
|
||||
end: Date;
|
||||
end: Time | Date;
|
||||
/**
|
||||
* Gets or sets the location of an appointment.
|
||||
*
|
||||
@@ -9737,8 +9747,8 @@ declare namespace Office {
|
||||
*
|
||||
* **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read
|
||||
*/
|
||||
location: string;
|
||||
/**
|
||||
location: Location | string;
|
||||
/**
|
||||
* Provides access to the optional attendees of an event. The type of object and level of access depends on the mode of the current item.
|
||||
*
|
||||
* *Read mode*
|
||||
@@ -9827,7 +9837,7 @@ declare namespace Office {
|
||||
*
|
||||
* **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read
|
||||
*/
|
||||
start: Date;
|
||||
start: Time | Date;
|
||||
/**
|
||||
* Gets or sets the description that appears in the subject field of an item.
|
||||
*
|
||||
@@ -9849,7 +9859,7 @@ declare namespace Office {
|
||||
*
|
||||
* **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read
|
||||
*/
|
||||
subject: string;
|
||||
subject: Subject | string;
|
||||
}
|
||||
/**
|
||||
* The appointment attendee mode of {@link Office.Item | Office.context.mailbox.item}.
|
||||
@@ -9995,13 +10005,15 @@ declare namespace Office {
|
||||
*/
|
||||
itemClass: string;
|
||||
/**
|
||||
* Gets the Exchange Web Services item identifier for the current item.
|
||||
* Gets the {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services item identifier}
|
||||
* for the current item.
|
||||
*
|
||||
* The itemId property is not available in compose mode.
|
||||
* 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
|
||||
* {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | 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}.
|
||||
@@ -11095,10 +11107,10 @@ declare namespace Office {
|
||||
color: MailboxEnums.CategoryColor | string;
|
||||
}
|
||||
/**
|
||||
* Represents a contact stored on the server. Read mode only.
|
||||
* Represents the details about a contact (similar to what's on a physical contact or business card) extracted from the item's body. Read mode only.
|
||||
*
|
||||
* The list of contacts associated with an email message or appointment is returned in the contacts property of the {@link Office.Entities | Entities} object
|
||||
* that is returned by the getEntities or getEntitiesByType method of the active item.
|
||||
* The list of contacts extracted from the body of an email message or appointment is returned in the contacts property of the
|
||||
* {@link Office.Entities | Entities} object returned by the getEntities or getEntitiesByType method of the current item.
|
||||
*
|
||||
* [Api set: Mailbox 1.0]
|
||||
*
|
||||
@@ -12334,6 +12346,11 @@ declare namespace Office {
|
||||
* To access the selected data from the callback method, call asyncResult.value.data.
|
||||
* To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject.
|
||||
*
|
||||
* **Note**: In Outlook on the web, the method returns the string "null" if no text is selected but the cursor is in the body.
|
||||
* To check for this situation, include code similar to the following:
|
||||
*
|
||||
* `var selectedText = (asyncResult.value.endPosition === asyncResult.value.startPosition) ? "" : asyncResult.value.data;`
|
||||
*
|
||||
* [Api set: Mailbox 1.2]
|
||||
*
|
||||
* @returns
|
||||
@@ -12362,6 +12379,11 @@ declare namespace Office {
|
||||
* To access the selected data from the callback method, call asyncResult.value.data.
|
||||
* To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject.
|
||||
*
|
||||
* **Note**: In Outlook on the web, the method returns the string "null" if no text is selected but the cursor is in the body.
|
||||
* To check for this situation, include code similar to the following:
|
||||
*
|
||||
* `var selectedText = (asyncResult.value.endPosition === asyncResult.value.startPosition) ? "" : asyncResult.value.data;`
|
||||
*
|
||||
* [Api set: Mailbox 1.2]
|
||||
*
|
||||
* @returns
|
||||
@@ -12638,13 +12660,15 @@ declare namespace Office {
|
||||
*/
|
||||
itemClass: string;
|
||||
/**
|
||||
* Gets the Exchange Web Services item identifier for the current item.
|
||||
* Gets the {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services item identifier}
|
||||
* for the current item.
|
||||
*
|
||||
* The itemId property is not available in compose mode.
|
||||
* 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
|
||||
* {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | 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}.
|
||||
@@ -14467,6 +14491,11 @@ declare namespace Office {
|
||||
* To access the selected data from the callback method, call asyncResult.value.data.
|
||||
* To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject.
|
||||
*
|
||||
* **Note**: In Outlook on the web, the method returns the string "null" if no text is selected but the cursor is in the body.
|
||||
* To check for this situation, include code similar to the following:
|
||||
*
|
||||
* `var selectedText = (asyncResult.value.endPosition === asyncResult.value.startPosition) ? "" : asyncResult.value.data;`
|
||||
*
|
||||
* [Api set: Mailbox 1.2]
|
||||
*
|
||||
* @returns
|
||||
@@ -14495,6 +14524,11 @@ declare namespace Office {
|
||||
* To access the selected data from the callback method, call asyncResult.value.data.
|
||||
* To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject.
|
||||
*
|
||||
* **Note**: In Outlook on the web, the method returns the string "null" if no text is selected but the cursor is in the body.
|
||||
* To check for this situation, include code similar to the following:
|
||||
*
|
||||
* `var selectedText = (asyncResult.value.endPosition === asyncResult.value.startPosition) ? "" : asyncResult.value.data;`
|
||||
*
|
||||
* [Api set: Mailbox 1.2]
|
||||
*
|
||||
* @returns
|
||||
@@ -14928,6 +14962,24 @@ declare namespace Office {
|
||||
* **Note**: This member is not supported in Outlook on iOS or Android.
|
||||
*/
|
||||
dateTimeModified: Date;
|
||||
/**
|
||||
* Gets the date and time that the appointment is to end.
|
||||
*
|
||||
* The end property is a Date object expressed as a Coordinated Universal Time (UTC) date and time value.
|
||||
* You can use the convertToLocalClientTime method to convert the end property value to the client's local date and time.
|
||||
*
|
||||
* When you use the Time.setAsync method to set the end time, you should use the convertToUtcClientTime method to convert the local time on
|
||||
* the client to UTC for the server.
|
||||
*
|
||||
* [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 Read
|
||||
*/
|
||||
end: Date;
|
||||
/**
|
||||
* Gets the email address of the sender of a message.
|
||||
*
|
||||
@@ -14997,13 +15049,15 @@ declare namespace Office {
|
||||
*/
|
||||
itemClass: string;
|
||||
/**
|
||||
* Gets the Exchange Web Services item identifier for the current item.
|
||||
* Gets the {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services item identifier}
|
||||
* for the current item.
|
||||
*
|
||||
* The itemId property is not available in compose mode.
|
||||
* 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
|
||||
* {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | 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}.
|
||||
@@ -15032,6 +15086,20 @@ declare namespace Office {
|
||||
* **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read
|
||||
*/
|
||||
itemType: MailboxEnums.ItemType | string;
|
||||
/**
|
||||
* Gets the location of a meeting request.
|
||||
*
|
||||
* The location property returns a string that contains the location of the appointment.
|
||||
*
|
||||
* [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 Read
|
||||
*/
|
||||
location: string;
|
||||
/**
|
||||
* Gets the subject of an item, with all prefixes removed (including RE: and FWD:).
|
||||
*
|
||||
@@ -15122,6 +15190,21 @@ declare namespace Office {
|
||||
* **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read
|
||||
*/
|
||||
sender: EmailAddressDetails;
|
||||
/**
|
||||
* Gets the date and time that the appointment is to begin.
|
||||
*
|
||||
* The start property is a Date object expressed as a Coordinated Universal Time (UTC) date and time value.
|
||||
* You can use the convertToLocalClientTime method to convert the value to the client's local date and time.
|
||||
*
|
||||
* [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 Read
|
||||
*/
|
||||
start: Date;
|
||||
/**
|
||||
* Gets the description that appears in the subject field of an item.
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user