[office-js] [office-js-preview] Add documentation for Coercion… (#42658)

This commit is contained in:
Elizabeth Samuel
2020-02-26 11:36:52 -08:00
committed by GitHub
parent f6e3b3cdc6
commit efd0ce7e42
2 changed files with 18 additions and 6 deletions
+10 -4
View File
@@ -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<void>;
/**
* Get the current startup behavior for the add-in.
* Gets the current startup behavior for the add-in.
*/
getStartupBehavior(): Promise<Office.StartupBehavior>;
/**
@@ -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.
+8 -2
View File
@@ -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.