From efd0ce7e4218a1ec3869980cf7dcdc87d6837f9c Mon Sep 17 00:00:00 2001 From: Elizabeth Samuel Date: Wed, 26 Feb 2020 11:36:52 -0800 Subject: [PATCH] =?UTF-8?q?[office-js]=20[office-js-preview]=20Add=20docum?= =?UTF-8?q?entation=20for=20Coercion=E2=80=A6=20(#42658)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- types/office-js-preview/index.d.ts | 14 ++++++++++---- types/office-js/index.d.ts | 10 ++++++++-- 2 files changed, 18 insertions(+), 6 deletions(-) diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index 79d18965c3..82b4e5d751 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.d.ts @@ -534,12 +534,12 @@ declare namespace Office { */ interface Addin { /** - * Set the startup behavior for the add-in for when the document is opened next time. + * Sets the startup behavior for the add-in for when the document is opened next time. * @param behavior - Specifies startup behavior of the add-in. */ setStartupBehavior(behavior: Office.StartupBehavior): Promise; /** - * Get the current startup behavior for the add-in. + * Gets the current startup behavior for the add-in. */ getStartupBehavior(): Promise; /** @@ -9008,7 +9008,13 @@ declare namespace Office { Last = "last" } } + /** + * Provides an option for the data format. + */ interface CoercionTypeOptions { + /** + * The desired data format. + */ coercionType?: Office.CoercionType | string; } /** @@ -12868,7 +12874,7 @@ declare namespace Office { * * *REST Tokens* * - * When a REST token is requested (`options.isRest = true`), the resulting token will not work to authenticate Exchange Web Services calls. + * When a REST token is requested (`options.isRest` = `true`), the resulting token will not work to authenticate Exchange Web Services calls. * The token will be limited in scope to read-only access to the current item and its attachments, unless the add-in has specified the * `ReadWriteMailbox` permission in its manifest. * If the `ReadWriteMailbox` permission is specified, the resulting token will grant read/write access to mail, calendar, and contacts, @@ -12888,7 +12894,7 @@ declare namespace Office { * * *EWS Tokens* * - * When an EWS token is requested (`options.isRest = false`), the resulting token will not work to authenticate REST API calls. + * When an EWS token is requested (`options.isRest` = `false`), the resulting token will not work to authenticate REST API calls. * The token will be limited in scope to accessing the current item. * * The add-in should use the `ewsUrl` property to determine the correct URL to use when making EWS calls. diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 14f7428964..e81d888973 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -8765,7 +8765,13 @@ declare namespace Office { Last = "last" } } + /** + * Provides an option for the data format. + */ interface CoercionTypeOptions { + /** + * The desired data format. + */ coercionType?: Office.CoercionType | string; } /** @@ -12525,7 +12531,7 @@ declare namespace Office { * * *REST Tokens* * - * When a REST token is requested (`options.isRest = true`), the resulting token will not work to authenticate Exchange Web Services calls. + * When a REST token is requested (`options.isRest` = `true`), the resulting token will not work to authenticate Exchange Web Services calls. * The token will be limited in scope to read-only access to the current item and its attachments, unless the add-in has specified the * `ReadWriteMailbox` permission in its manifest. * If the `ReadWriteMailbox` permission is specified, the resulting token will grant read/write access to mail, calendar, and contacts, @@ -12545,7 +12551,7 @@ declare namespace Office { * * *EWS Tokens* * - * When an EWS token is requested (`options.isRest = false`), the resulting token will not work to authenticate REST API calls. + * When an EWS token is requested (`options.isRest` = `false`), the resulting token will not work to authenticate REST API calls. * The token will be limited in scope to accessing the current item. * * The add-in should use the `ewsUrl` property to determine the correct URL to use when making EWS calls.