@types/office-runtime - npm Package Compare versions

Comparing version 1.0.10 to 1.0.11

office-runtime/index.d.ts

@@ -9,2 +9,3 @@ // Type definitions for non-npm package office-runtime 1.0
 //                 Sudhi Ramamurthy <https://github.com/sumurthy>
+//                 Ricky Kirkham <https://github.com/rick-kirkham>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -22,6 +23,97 @@ // Typescript Version: 2.4
 declare namespace OfficeRuntime {
+    /**
+     * Encapsulates methods that interact with the Office UI.
+     * @beta
+     */
+    interface UI {
+        /**
+         * Get the ribbon of the Office application.
+         */
+        getRibbon(): Promise<Ribbon>;
+    }
+    /**
+     * Encapsulates the management of the Office ribbon state.
+     * @beta
+     */
+    interface Ribbon {
+        /**
+         * Stages the updates to be made to the ribbon.
+         * Note that this API only requests an update. The actual UI update to the ribbon is controlled by the
+         * Office application and hence the exact timing of the ribbon update (or refresh) cannot be determined
+         * by the completion of this API.
+         * @param input Represents the updates to be made to the ribbon. Note that the only changes made to the ribbon
+         * are those specified in the input parameter. In all other respects, the ribbon is not changed.
+         */
+        requestUpdate(input: RibbonUpdaterData): Promise<void>;
+    }
+    /**
+     * Represents the parts of the ribbon that the call to `requestUpdate` will change.
+     * @beta
+     */
+    interface RibbonUpdaterData {
+        /**
+         * Array of the tabs whose state is set with a call to `requestUpdate`.
+         */
+        tabs?: Tab [];
+    }
+    /**
+     * Represents an individual tab and the state it should have.
+     * @beta
+     */
+    interface Tab {
+        /**
+         * Identifier of the tab as specified in the manifest.
+         */
+        id: string;
+        /**
+         * Represents an array of controls in the tab whose state is set with the call to `requestUpdate`.
+         */
+        controls?: Control[];
+    }
+    /**
+     * Represent an individual control or command whose state is set with the call to `requestUpdate`.
+     * @beta
+     */
+    interface Control {
+        /**
+         * Identifier of the control as specified in the manifest.
+         */
+        id: string;
+        /**
+         * Indicates whether the control should be enabled (default) or disabled.
+         */
+        enabled?: boolean;
+    }
+    /**
+     * Represent an individual gallery control.
+     * @beta
+     */
+    interface Gallery extends Control {
+        /**
+         * Used to refresh a gallery control including optional data to be passed to the gallery control at the time of refresh action.
+         */
+        refreshData?: {};
+    }
+    /**
+     * Represents an individual menu item whose state is set with the call to `requestUpdate`.
+     * @beta
+     */
+    interface MenuControl {
+        /**
+         * Identifier of the menu item as specified in the manifest.
+         */
+        id?: string;
+        /**
+         * The position of the item in the menu.
+         */
+        position?: number;
+        /**
+         * Indicates whether the menu item should be enabled (default) or disabled.
+         */
+        enabled?: boolean;
+    }
   /**
    * Method that enables a pop up web dialog box.
    *
-   * [Api set: CustomFunctionsRuntime 1.1]
+   * [Api set: SharedRuntime 1.1]
    *
@@ -39,3 +131,3 @@ * @param url Must be a string.
    *
-   * [Api set: CustomFunctionsRuntime 1.1]
+   * [Api set: SharedRuntime 1.1]
    *
@@ -50,3 +142,3 @@ * @remarks
      *
-     * [Api set: CustomFunctionsRuntime 1.1]
+     * [Api set: SharedRuntime 1.1]
      *
@@ -60,3 +152,3 @@ * @param key Key of item to be retrieved. Must be a string.
      *
-     * [Api set: CustomFunctionsRuntime 1.1]
+     * [Api set: SharedRuntime 1.1]
      *
@@ -71,3 +163,3 @@ * @param key Key of item to be set. Must be a string.
      *
-     * [Api set: CustomFunctionsRuntime 1.1]
+     * [Api set: SharedRuntime 1.1]
      *
@@ -81,3 +173,3 @@ * @param key Key of item to be removed. Must be a string.
      *
-     * [Api set: CustomFunctionsRuntime 1.1]
+     * [Api set: SharedRuntime 1.1]
      *
@@ -91,3 +183,3 @@ * @param keys Keys of items to be removed. Must be an array of strings.
      *
-     * [Api set: CustomFunctionsRuntime 1.1]
+     * [Api set: SharedRuntime 1.1]
      *
@@ -101,3 +193,3 @@ * @param keyValues Key-value pairs to be set. Must be strings.
      *
-     * [Api set: CustomFunctionsRuntime 1.1]
+     * [Api set: SharedRuntime 1.1]
      *
@@ -111,3 +203,3 @@ * @param keys Keys of items to be removed. Must be an array of strings.
      *
-     * [Api set: CustomFunctionsRuntime 1.1]
+     * [Api set: SharedRuntime 1.1]
      *
@@ -122,3 +214,3 @@ */
      *
-     * [Api set: CustomFunctionsRuntime 1.1]
+     * [Api set: SharedRuntime 1.1]
      *
@@ -134,3 +226,3 @@ */
      *
-     * [Api set: CustomFunctionsRuntime 1.1]
+     * [Api set: SharedRuntime 1.1]
      *
@@ -143,3 +235,3 @@ */
      *
-     * [Api set: CustomFunctionsRuntime 1.1]
+     * [Api set: SharedRuntime 1.1]
      *
@@ -152,3 +244,3 @@ */
      *
-     * [Api set: CustomFunctionsRuntime 1.1]
+     * [Api set: SharedRuntime 1.1]
      *
@@ -160,3 +252,3 @@ */
      *
-     * [Api set: CustomFunctionsRuntime 1.1]
+     * [Api set: SharedRuntime 1.1]
      *
@@ -168,3 +260,3 @@ */
      *
-     * [Api set: CustomFunctionsRuntime 1.1]
+     * [Api set: SharedRuntime 1.1]
      *
@@ -176,3 +268,3 @@ */
      *
-     * [Api set: CustomFunctionsRuntime 1.1]
+     * [Api set: SharedRuntime 1.1]
      *
@@ -179,0 +271,0 @@ */

office-runtime/package.json

 {
     "name": "@types/office-runtime",
-    "version": "1.0.10",
+    "version": "1.0.11",
     "description": "TypeScript definitions for office-runtime",
@@ -36,2 +36,7 @@ "license": "MIT",
             "githubUsername": "sumurthy"
+        },
+        {
+            "name": "Ricky Kirkham",
+            "url": "https://github.com/rick-kirkham",
+            "githubUsername": "rick-kirkham"
         }
@@ -48,4 +53,4 @@ ],
     "dependencies": {},
-    "typesPublisherContentHash": "67b7567370d64a92252b7b3769c480a49fc3222bc59afdb65d8cf462eb0111f0",
+    "typesPublisherContentHash": "879ad6a9ce2a12dae3f96b92385bf7a2fa7af9f46cfc128ea119761b68393af4",
     "typeScriptVersion": "2.8"
 }

office-runtime/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Mon, 11 Nov 2019 19:17:16 GMT
+ * Last updated: Wed, 12 Feb 2020 18:46:21 GMT
  * Dependencies: none
@@ -17,2 +17,2 @@ * Global values: `OfficeRuntime`
 # Credits
-These definitions were written by OfficeDev (https://github.com/OfficeDev), Michael Zlatskovsky (https://github.com/Zlatkovsky), Michelle Scharlock (https://github.com/mscharlock), David Chesnut (https://github.com/davidchesnut), Alex Jerabek (https://github.com/AlexJerabek), and Sudhi Ramamurthy (https://github.com/sumurthy).
+These definitions were written by OfficeDev (https://github.com/OfficeDev), Michael Zlatskovsky (https://github.com/Zlatkovsky), Michelle Scharlock (https://github.com/mscharlock), David Chesnut (https://github.com/davidchesnut), Alex Jerabek (https://github.com/AlexJerabek), Sudhi Ramamurthy (https://github.com/sumurthy), and Ricky Kirkham (https://github.com/rick-kirkham).

No alert changes

Improved metrics

Total package byte prevSize

16260

22.71%

Lines of code

342

36.8%

No dependency changes