@types/office-js 1.0.328 → 1.0.330

office-js/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
 
 ### Additional Details
- * Last updated: Tue, 06 Jun 2023 23:02:52 GMT
+ * Last updated: Tue, 13 Jun 2023 23:02:49 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js/index.d.ts

@@ -1544,17 +1544,23 @@ declare namespace Office {
          *
          * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/identity-api-requirement-sets | IdentityAPI 1.3}
          *
-         * **Important**: In Outlook, this API isn't supported in the following scenarios.
+         * **Important**:
+         *
+         * - In Outlook, this API isn't supported in the following scenarios.
+         *
+         *   - If the add-in is loaded in an Outlook.com or Gmail mailbox.
          *
-         * - If the add-in is loaded in an Outlook.com or Gmail mailbox.
+         *   - If the add-in is loaded in Outlook on the web in the Safari browser. This results in error 13001 ("The user is not signed into Office").
          *
-         * - If the add-in is loaded in Outlook on the web in the Safari browser. This results in error 13001 ("The user is not signed into Office").
+         * - In Outlook on the web, if you use the
+         * {@link https://learn.microsoft.com/javascript/api/office/office.ui#office-office-ui-displaydialogasync-member(1) | displayDialogAsync}
+         * method to open a dialog, you must close the dialog before you can call `getAccessToken`.
          *
-         * **Note**: In an Outlook event-based activation add-in, this API is supported in Outlook on Windows starting from Version 2111 (Build 14701.20000).
+         * - In an Outlook event-based activation add-in, this API is supported in Outlook on Windows starting from Version 2111 (Build 14701.20000).
          * To retrieve an access token in older builds, use 
-         * {@link https://learn.microsoft.com/javascript/api/office-runtime/officeruntime.auth?view=common-js#office-runtime-officeruntime-auth-getaccesstoken-member(1) |
-         * OfficeRuntime.auth.getAccessToken} instead. For more information, see 
-         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-sso-in-event-based-activation | Enable single sign-on (SSO) in Outlook add-ins that use event-based activation}.
+         * {@link https://learn.microsoft.com/javascript/api/office-runtime/officeruntime.auth?view=common-js-preview#office-runtime-officeruntime-auth-getaccesstoken-member(1) |
+        * OfficeRuntime.auth.getAccessToken} instead. For more information, see 
+        * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-sso-in-event-based-activation | Enable single sign-on (SSO) in Outlook add-ins that use event-based activation}.
          *
          * @param options - Optional. Accepts an `AuthOptions` object to define sign-on behaviors.
          * @returns Promise to the access token.
@@ -19342,8 +19348,15 @@ declare namespace OfficeExtension {
         readonly debugInfo: RequestContextDebugInfo;
     }
 
+    /**
+     * Specifies options for a session of a Visio diagram embedded in a SharePoint page. Called by constructor of `EmbeddedSession`.
+	 * For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/reference/overview/visio-javascript-reference-overview | Visio JavaScript API overview}.
+     */
     interface EmbeddedOptions {
         sessionKey?: string,
+		/*
+		* The iframe element that hosts the Visio diagram.
+		*/
         container?: HTMLElement,
         id?: string;
         timeoutInMilliseconds?: number;
@@ -19351,8 +19364,15 @@ declare namespace OfficeExtension {
         width?: string;
     }
 
+    /**
+     * Represents a session of a Visio diagram embedded in a SharePoint page. 
+	 * For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/reference/overview/visio-javascript-reference-overview | Visio JavaScript API overview}.
+     */
     class EmbeddedSession {
         constructor(url: string, options?: EmbeddedOptions);
+		/**
+		* Initializes the session.
+		*/
         public init(): Promise<any>;
     }
 
@@ -19518,13 +19538,25 @@ declare namespace OfficeExtension {
         remove(handler: (args: T) => Promise<any>): void;
     }
 
+    /**
+    * Enables the removal of an event handler. Returned by the `EventHandlers.add` method.
+	*
+	* **Note**: The same {@link OfficeExtension.ClientRequestContext | RequestContext} object that the handler was added in must be used when removing the handler.
+    * More information can be found in {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-events#remove-an-event-handler | Remove an event handler}.
+    */
     class EventHandlerResult<T> {
         constructor(context: ClientRequestContext, handlers: EventHandlers<T>, handler: (args: T) => Promise<any>);
         /** The request context associated with the object */
         context: ClientRequestContext;
+		/*
+		* Removes the handler from the event.
+		*/
         remove(): void;
     }
 
+    /**
+	* Used by Office to construct event handlers. Do not call in your code.
+	*/
     interface EventInfo<T> {
         registerFunc: (callback: (args: any) => void) => Promise<any>;
         unregisterFunc: (callback: (args: any) => void) => Promise<any>;

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.328",
+    "version": "1.0.330",
     "description": "TypeScript definitions for Office.js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
     "license": "MIT",
@@ -45,6 +45,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "241809be6e9b550afa2f9adbbac21123be3e724db8de4d44b354a261eddc0655",
+    "typesPublisherContentHash": "964ad412f7aa9567890052670913dde4959ac0111bf4bd09072782388c86c511",
     "typeScriptVersion": "4.3"
 }