@types/office-js-preview 1.0.390 → 1.0.391

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Tue, 06 Jun 2023 23:02:52 GMT
11
+ * Last updated: Fri, 09 Jun 2023 17:33:06 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
14
14
 
@@ -19745,8 +19745,15 @@ declare namespace OfficeExtension {
19745
19745
  readonly debugInfo: RequestContextDebugInfo;
19746
19746
  }
19747
19747
 
19748
+ /**
19749
+ * Specifies options for a session of a Visio diagram embedded in a SharePoint page. Called by constructor of `EmbeddedSession`.
19750
+ * For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/reference/overview/visio-javascript-reference-overview | Visio JavaScript API overview}.
19751
+ */
19748
19752
  interface EmbeddedOptions {
19749
19753
  sessionKey?: string,
19754
+ /*
19755
+ * The iframe element that hosts the Visio diagram.
19756
+ */
19750
19757
  container?: HTMLElement,
19751
19758
  id?: string;
19752
19759
  timeoutInMilliseconds?: number;
@@ -19754,8 +19761,15 @@ declare namespace OfficeExtension {
19754
19761
  width?: string;
19755
19762
  }
19756
19763
 
19764
+ /**
19765
+ * Represents a session of a Visio diagram embedded in a SharePoint page.
19766
+ * For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/reference/overview/visio-javascript-reference-overview | Visio JavaScript API overview}.
19767
+ */
19757
19768
  class EmbeddedSession {
19758
19769
  constructor(url: string, options?: EmbeddedOptions);
19770
+ /**
19771
+ * Initializes the session.
19772
+ */
19759
19773
  public init(): Promise<any>;
19760
19774
  }
19761
19775
 
@@ -19921,13 +19935,25 @@ declare namespace OfficeExtension {
19921
19935
  remove(handler: (args: T) => Promise<any>): void;
19922
19936
  }
19923
19937
 
19938
+ /**
19939
+ * Enables the removal of an event handler. Returned by the `EventHandlers.add` method.
19940
+ *
19941
+ * **Note**: The same {@link OfficeExtension.ClientRequestContext | RequestContext} object that the handler was added in must be used when removing the handler.
19942
+ * 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}.
19943
+ */
19924
19944
  class EventHandlerResult<T> {
19925
19945
  constructor(context: ClientRequestContext, handlers: EventHandlers<T>, handler: (args: T) => Promise<any>);
19926
19946
  /** The request context associated with the object */
19927
19947
  context: ClientRequestContext;
19948
+ /**
19949
+ * Removes the handler from the event.
19950
+ */
19928
19951
  remove(): void;
19929
19952
  }
19930
19953
 
19954
+ /**
19955
+ * Used by Office to construct event handlers. Do not call in your code.
19956
+ */
19931
19957
  interface EventInfo<T> {
19932
19958
  registerFunc: (callback: (args: any) => void) => Promise<any>;
19933
19959
  unregisterFunc: (callback: (args: any) => void) => Promise<any>;
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.390",
3
+ "version": "1.0.391",
4
4
  "description": "TypeScript definitions for Office.js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
6
6
  "license": "MIT",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "4132ee09f0f1aa62aff386a27be22dd3368ff1dd3ea773aaefacf70199b41ad0",
48
+ "typesPublisherContentHash": "876c566111b10a806622789993158019b4205d5d8e5e5c5d54a7c6fbfcb62186",
49
49
  "typeScriptVersion": "4.3"
50
50
  }