vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-10-04 23:07:06 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Standardizing Outlook Remarks

Browse Source
This commit is contained in:
Alex Jerabek
2018-06-25 14:22:48 -07:00
parent 14e6c479b6
commit caef6351af
1 changed files with 58 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/office-js/index.d.ts
Vendored
+58 -56
View File
@@ -7204,11 +7204,11 @@ declare namespace Office {
*
* @remarks
*
* Note: This member is not supported in Outlook for iOS or Outlook for Android.
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>ReadItem</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Appointment Organizer</td></tr></table>
*
* Note: This member is not supported in Outlook for iOS or Outlook for Android.
*/
dateTimeModifed: Date;
/**
@@ -7288,14 +7288,14 @@ declare namespace Office {
* [Api set: Mailbox Preview]
*
* @remarks
*
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>ReadItem</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Appointment Organizer</td></tr></table>
*
* In addition to this signature, the method also has the following signature:
*
* `addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void;`
*
* <tr><td>Applicable Outlook mode</td><td>Appointment Organizer</td></tr></table>
*
* @param eventType The event that should invoke the handler.
* @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. The type property on the parameter will match the eventType parameter passed to addHandlerAsync.
@@ -7639,11 +7639,11 @@ declare namespace Office {
*
* @remarks
*
* More information on {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | actionable messages}.
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>ReadItem</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Appointment Organizer</td></tr></table>
*
* More information on {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | actionable messages}.
*
* @param options Optional. 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.
@@ -7652,7 +7652,7 @@ declare namespace Office {
* @beta
*/
getInitializationContextAsync(options?: AsyncContextOptions, callback?: (result: AsyncResult) => 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.
@@ -7709,7 +7709,7 @@ declare namespace Office {
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>ReadWriteItem</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Appointment Organizer</td></tr></table>
* <tr><td>Applicable Outlook mode</td><td>Appointment Organizer</td></tr>
*
* <tr><td>Errors</td><td>InvalidAttachmentId - The attachment identifier does not exist.</td></tr></table>
*
@@ -8120,11 +8120,11 @@ declare namespace Office {
*
* @remarks
*
* Note: This member is not supported in Outlook for iOS or Outlook for Android.
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>ReadItem</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Appointment Attendee</td></tr></table>
*
* Note: This member is not supported in Outlook for iOS or Outlook for Android.
*/
dateTimeModifed: Date;
/**
@@ -8318,19 +8318,18 @@ declare namespace Office {
* [Api set: Mailbox 1.0]
*
* @remarks
*
* 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}.
*
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>ReadItem</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Appointment Attendee</td></tr></table>
*
* 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}.
*
*/
attachments: AttachmentDetails[];
/**
* Gets the Exchange Web Services item class of the selected item.
*
*
* You can create custom message classes that extends a default message class, for example, a custom appointment message class IPM.Appointment.Contoso.
*
@@ -8876,11 +8875,11 @@ declare namespace Office {
*
* @remarks
*
* Note: This member is not supported in Outlook for iOS or Outlook for Android.
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>ReadItem</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Read</td></tr></table>
*
* Note: This member is not supported in Outlook for iOS or Outlook for Android.
*/
dateTimeModifed: Date;
/**
@@ -9317,12 +9316,12 @@ declare namespace Office {
*
* @remarks
*
* More information on {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | actionable messages}.
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>ReadItem</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Read</td></tr></table>
*
* More information on {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | actionable messages}.
*
* @param options Optional. 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 Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. On success, the initialization data is provided in the asyncResult.value property as a string. If there is no initialization context, the asyncResult object will contain an Error object with its code property set to 9020 and its name property set to GenericResponseError.
@@ -9686,13 +9685,12 @@ declare namespace Office {
* [Api set: Mailbox 1.0]
*
* @remarks
*
* 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}.
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>ReadItem</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Read</td></tr></table>
*
* 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}.
*
*/
attachments: AttachmentDetails[];
/**
@@ -10165,11 +10163,11 @@ declare namespace Office {
*
* @remarks
*
* Note: This member is not supported in Outlook for iOS or Outlook for Android.
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>ReadItem</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Message Compose</td></tr></table>
*
* Note: This member is not supported in Outlook for iOS or Outlook for Android.
*/
dateTimeModifed: Date;
/**
@@ -10600,12 +10598,12 @@ declare namespace Office {
*
* @remarks
*
* More information on {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | actionable messages}.
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>ReadItem</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Message Compose</td></tr></table>
*
* More information on {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | actionable messages}.
*
* @param options Optional. 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 Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. On success, the initialization data is provided in the asyncResult.value property as a string. If there is no initialization context, the asyncResult object will contain an Error object with its code property set to 9020 and its name property set to GenericResponseError.
@@ -11071,11 +11069,11 @@ declare namespace Office {
*
* @remarks
*
* Note: This member is not supported in Outlook for iOS or Outlook for Android.
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>ReadItem</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Message Read</td></tr></table>
*
* Note: This member is not supported in Outlook for iOS or Outlook for Android.
*/
dateTimeModifed: Date;
/**
@@ -11270,11 +11268,11 @@ declare namespace Office {
*
* @remarks
*
* 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}.
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>ReadItem</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Message Read</td></tr></table>
*
* 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}.
*
*/
attachments: AttachmentDetails[];
@@ -11476,6 +11474,10 @@ declare namespace Office {
*
* @remarks
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>Restricted</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Read</td></tr></table>
*
* While the minimum permission level to use this method is Restricted, some entity types require ReadItem to access, as specified in the following table.
*
* <table>
@@ -11520,10 +11522,6 @@ declare namespace Office {
* <td>Restricted</td>
* </tr>
* </table>
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>Restricted</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Read</td></tr></table>
*/
getEntitiesByType(entityType: Office.MailboxEnums.EntityType): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[];
/**
@@ -11851,17 +11849,17 @@ declare namespace Office {
*
* In compose mode you must call the saveAsync method before you can use the ewsUrl member. Your app must have ReadWriteItem permissions to call the saveAsync method.
*
* Note: This member is not supported in Outlook for iOS or Outlook for Android.
*
* [Api set: Mailbox 1.0]
*
* @remarks
*
* 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://msdn.microsoft.com/library/office/dn148008.aspx | get attachments from the selected item}.
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>ReadItem</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Compose or read</td></tr></table>
*
* 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://msdn.microsoft.com/library/office/dn148008.aspx | get attachments from the selected item}.
*
* Note: This member is not supported in Outlook for iOS or Outlook for Android.
*/
ewsUrl: string;
/**
@@ -11881,11 +11879,11 @@ declare namespace Office {
*
* @remarks
*
* The restUrl value can be used to make {@link https://docs.microsoft.com/outlook/rest/ | REST API} calls to the user's mailbox.
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>ReadItem</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Compose or read</td></tr></table>
*
* The restUrl value can be used to make {@link https://docs.microsoft.com/outlook/rest/ | REST API} calls to the user's mailbox.
*/
restUrl: string;
/**
@@ -11958,13 +11956,13 @@ declare namespace Office {
* [Api set: Mailbox 1.3]
*
* @remarks
*
* Item IDs retrieved via EWS or via the itemId property use a different format than the format used by REST APIs (such as the {@link https://msdn.microsoft.com/office/office365/APi/mail-rest-operations | Outlook Mail API} or the {@link http://graph.microsoft.io/ | Microsoft Graph}. The convertToRestId method converts an EWS-formatted ID into the proper format for REST.
*
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>Restricted</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Compose or read</td></tr></table>
*
* Item IDs retrieved via EWS or via the itemId property use a different format than the format used by REST APIs (such as the {@link https://msdn.microsoft.com/office/office365/APi/mail-rest-operations | Outlook Mail API} or the {@link http://graph.microsoft.io/ | Microsoft Graph}. The convertToRestId method converts an EWS-formatted ID into the proper format for REST.
*
* @param itemId An item ID formatted for Exchange Web Services (EWS)
* @param restVersion A value indicating the version of the Outlook REST API that the converted ID will be used with.
*/
@@ -12180,12 +12178,12 @@ declare namespace Office {
*
* @remarks
*
* The getUserIdentityTokenAsync method returns a token that you can use to identify and {@link https://msdn.microsoft.com/library/office/fp179828.aspx | authenticate the add-in and user with a third-party system}.
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>ReadItem</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Compose and read</td></tr></table>
*
* The getUserIdentityTokenAsync method returns a token that you can use to identify and {@link https://msdn.microsoft.com/library/office/fp179828.aspx | authenticate the add-in and user with a third-party system}.
*
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult.
* @param userContext Optional. Any state data that is passed to the asynchronous method.|
*/
@@ -12766,9 +12764,9 @@ declare namespace Office {
* @remarks
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>ReadWriteItem</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Compose<tr><td>Errors</td>
* <tr><td>Applicable Outlook mode</td><td>Compose</td></tr>
*
* <tr><td>Errors</td><td>NumberOfRecipientsExceeded - The number of recipients exceeded 100 entries.<tr><td>Errors</td><td>
* <tr><td>Errors</td><td>NumberOfRecipientsExceeded - The number of recipients exceeded 100 entries.</td></tr></table>
*
* In addition to the main signature, this method also has these signatures:
*
@@ -12872,6 +12870,12 @@ declare namespace Office {
*
* @remarks
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>ReadItem</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Compose or read</td></tr></table>
*
* **States**
*
* <table>
* <tr>
* <th>State</th>
@@ -12910,10 +12914,6 @@ declare namespace Office {
* </tr>
* </table>
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>ReadItem</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Compose or read</td></tr></table>
*
* @beta
*/
export interface Recurrence {
@@ -13727,7 +13727,7 @@ declare namespace Office {
*/
interface UserProfile {
/**
* Gets the account type of the user associated with the mailbox. The possible values are listed in the following table.
* 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.
*
@@ -13735,6 +13735,12 @@ declare namespace Office {
*
* @remarks
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>ReadItem</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Compose or read</td></tr></table>
*
* The possible account types are listed in the following table.
*
* <table>
* <tr>
* <th>Value</th>
@@ -13757,10 +13763,6 @@ declare namespace Office {
* <td>The mailbox is associated with a personal Outlook.com account.</td>
* </tr>
* </table>
*
* <table><tr><td>{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}</td><td>ReadItem</td></tr>
*
* <tr><td>Applicable Outlook mode</td><td>Compose or read</td></tr></table>
*/
accountType: string;
/**