[office-js] [office-js-preview] (Outlook) Add note about Outlook value (#37441)

* [office-js] [office-js-preview] (Outlook) Add note about Outlook value

* Updates based on feedback
This commit is contained in:
Elizabeth Samuel
2019-08-07 14:23:10 -07:00
committed by Nathan Shively-Sanders
parent e949e6fec6
commit 4bdf407fb9
2 changed files with 20 additions and 14 deletions
+10 -7
View File
@@ -9393,6 +9393,8 @@ declare namespace Office {
*
* A string that can be one of the following values: "Outlook", "OutlookWebApp", "OutlookIOS", or "OutlookAndroid".
*
* **Note**: The "Outlook" value is returned for Outlook on desktop clients (i.e., Windows and Mac).
*
* [Api set: Mailbox 1.0]
*
* @remarks
@@ -9403,10 +9405,10 @@ declare namespace Office {
*/
hostName: string;
/**
* Gets a string that represents the version of either the host application or the Exchange Server.
* Gets a string that represents the version of either the host application or the Exchange Server (e.g., "15.0.468.0").
*
* If the mail add-in is running in Outlook client on the desktop or iOS, the hostVersion property returns the version of the host
* application, Outlook. In Outlook on the web, the property returns the version of the Exchange Server. An example is the string "15.0.468.0".
* If the mail add-in is running in Outlook on a desktop or mobile client, the hostVersion property returns the version of the host
* application, Outlook. In Outlook on the web, the property returns the version of the Exchange Server.
*
* [Api set: Mailbox 1.0]
*
@@ -14985,11 +14987,12 @@ declare namespace Office {
* Contains the following members:
*
* - hostName (string): A string that represents the name of the host application.
* It be one of the following values: "Outlook", "OutlookWebApp", "OutlookIOS", or "OutlookAndroid".
* It should be one of the following values: "Outlook", "OutlookWebApp", "OutlookIOS", or "OutlookAndroid".
* **Note**: The "Outlook" value is returned for Outlook on desktop clients (i.e., Windows and Mac).
*
* - hostVersion (string): A string that represents the version of either the host application or the Exchange Server.
* If the mail add-in is running in Outlook on desktop clients or iOS, the hostVersion property returns the version of the
* host application, Outlook. In Outlook on the web, the property returns the version of the Exchange Server. An example is the string "15.0.468.0".
* - hostVersion (string): A string that represents the version of either the host application or the Exchange Server (e.g., "15.0.468.0").
* If the mail add-in is running in Outlook on desktop or mobile clients, the hostVersion property returns the version of the
* host application, Outlook. In Outlook on the web, the property returns the version of the Exchange Server.
*
* - OWAView (MailboxEnums.OWAView or string): An enum (or string literal) that represents the current view of Outlook on the web.
* If the host application is not Outlook on the web, then accessing this property results in undefined.
+10 -7
View File
@@ -9208,6 +9208,8 @@ declare namespace Office {
*
* A string that can be one of the following values: "Outlook", "OutlookWebApp", "OutlookIOS", or "OutlookAndroid".
*
* **Note**: The "Outlook" value is returned for Outlook on desktop clients (i.e., Windows and Mac).
*
* [Api set: Mailbox 1.0]
*
* @remarks
@@ -9218,10 +9220,10 @@ declare namespace Office {
*/
hostName: string;
/**
* Gets a string that represents the version of either the host application or the Exchange Server.
* Gets a string that represents the version of either the host application or the Exchange Server (e.g., "15.0.468.0").
*
* If the mail add-in is running in Outlook client on the desktop or iOS, the hostVersion property returns the version of the host
* application, Outlook. In Outlook on the web, the property returns the version of the Exchange Server. An example is the string "15.0.468.0".
* If the mail add-in is running in Outlook on a desktop or mobile client, the hostVersion property returns the version of the host
* application, Outlook. In Outlook on the web, the property returns the version of the Exchange Server.
*
* [Api set: Mailbox 1.0]
*
@@ -14613,11 +14615,12 @@ declare namespace Office {
* Contains the following members:
*
* - hostName (string): A string that represents the name of the host application.
* It be one of the following values: "Outlook", "OutlookWebApp", "OutlookIOS", or "OutlookAndroid".
* It should be one of the following values: "Outlook", "OutlookWebApp", "OutlookIOS", or "OutlookAndroid".
* **Note**: The "Outlook" value is returned for Outlook on desktop clients (i.e., Windows and Mac).
*
* - hostVersion (string): A string that represents the version of either the host application or the Exchange Server.
* If the mail add-in is running in Outlook on desktop clients or iOS, the hostVersion property returns the version of the
* host application, Outlook. In Outlook on the web, the property returns the version of the Exchange Server. An example is the string 15.0.468.0.
* - hostVersion (string): A string that represents the version of either the host application or the Exchange Server (e.g., "15.0.468.0").
* If the mail add-in is running in Outlook on desktop or mobile clients, the hostVersion property returns the version of the
* host application, Outlook. In Outlook on the web, the property returns the version of the Exchange Server.
*
* - OWAView (MailboxEnums.OWAView or string): An enum (or string literal) that represents the current view of Outlook on the web.
* If the host application is not Outlook on the web, then accessing this property results in undefined.