@microsoft/teams-js 2.0.0-beta.3-dev.30 → 2.0.0-beta.3-dev.34

package/dist/MicrosoftTeams.d.ts

@@ -2835,6 +2835,34 @@ export namespace pages {
         function returnFocus(navigateForward?: boolean): void;
         function setCurrentFrame(frameInfo: FrameInfo): void;
         function initializeWithFrameContext(frameInfo: FrameInfo, callback?: () => void, validMessageOrigins?: string[]): void;
+        interface InstanceConfig {
+                /**
+                    * A suggested display name for the new content.
+                    * In the settings for an existing instance being updated, this call has no effect.
+                    */
+                suggestedDisplayName?: string;
+                /**
+                    * Sets the URL to use for the content of this instance.
+                    */
+                contentUrl: string;
+                /**
+                    * Sets the URL for the removal configuration experience.
+                    */
+                removeUrl?: string;
+                /**
+                    * Sets the URL to use for the external link to view the underlying resource in a browser.
+                    */
+                websiteUrl?: string;
+                /**
+                    * The developer-defined unique ID for the entity to which this content points.
+                    */
+                entityId?: string;
+        }
+        /**
+            * Gets the config for the current instance.
+            * @returns Promise that resolves with the {@link InstanceConfig} object.
+            */
+        function getConfig(): Promise<InstanceConfig>;
         /**
             * Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
             * valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
@@ -2937,18 +2965,13 @@ export namespace pages {
                     * @param validityState Indicates whether the save or remove button is enabled for the user.
                     */
                 function setValidityState(validityState: boolean): void;
-                /**
-                    * Gets the config for the current instance.
-                    * @returns Promise that resolves with the {@link Config} object.
-                    */
-                function getConfig(): Promise<Config>;
                 /**
                     * Sets the config for the current instance.
                     * This is an asynchronous operation; calls to getConfig are not guaranteed to reflect the changed state.
-                    * @param Config The desired config for this instance.
+                    * @param instanceConfig The desired config for this instance.
                     * @returns Promise that resolves when the operation has completed.
                     */
-                function setConfig(instanceSettings: Config): Promise<void>;
+                function setConfig(instanceConfig: InstanceConfig): Promise<void>;
                 /**
                     * Registers a handler for when the user attempts to save the settings. This handler should be used
                     * to create or update the underlying resource powering the content.
@@ -2970,29 +2993,6 @@ export namespace pages {
                     * @param handler The handler to invoke when the user click on Settings.
                     */
                 function registerChangeConfigHandler(handler: () => void): void;
-                interface Config {
-                        /**
-                            * A suggested display name for the new content.
-                            * In the settings for an existing instance being updated, this call has no effect.
-                            */
-                        suggestedDisplayName?: string;
-                        /**
-                            * Sets the URL to use for the content of this instance.
-                            */
-                        contentUrl: string;
-                        /**
-                            * Sets the URL for the removal configuration experience.
-                            */
-                        removeUrl?: string;
-                        /**
-                            * Sets the URL to use for the external link to view the underlying resource in a browser.
-                            */
-                        websiteUrl?: string;
-                        /**
-                            * The developer-defined unique ID for the entity to which this content points.
-                            */
-                        entityId?: string;
-                }
                 interface SaveEvent {
                         /**
                             * Object containing properties passed as arguments to the settings.save event.
@@ -4679,7 +4679,7 @@ export namespace settings {
             * @remarks
             * Renamed to config in pages.Config
             */
-        export import Settings = pages.config.Config;
+        export import Settings = pages.InstanceConfig;
         /**
             * @deprecated
             * As of 2.0.0-beta.1, please use {@link pages.config.SaveEvent} instead.

package/dist/MicrosoftTeams.js

@@ -394,7 +394,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = "2.0.0-beta.3-dev.30";
+var version = "2.0.0-beta.3-dev.34";
 /**
  * @hidden
  * The SDK version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -2167,6 +2167,17 @@ var pages;
         setCurrentFrame(frameInfo);
     }
     pages.initializeWithFrameContext = initializeWithFrameContext;
+    /**
+     * Gets the config for the current instance.
+     * @returns Promise that resolves with the {@link InstanceConfig} object.
+     */
+    function getConfig() {
+        return new Promise(function (resolve) {
+            ensureInitialized(FrameContexts.content, FrameContexts.settings, FrameContexts.remove, FrameContexts.sidePanel);
+            resolve(sendAndUnwrap('settings.getSettings'));
+        });
+    }
+    pages.getConfig = getConfig;
     /**
      * Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
      * valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
@@ -2310,27 +2321,16 @@ var pages;
             sendMessageToParent('settings.setValidityState', [validityState]);
         }
         config.setValidityState = setValidityState;
-        /**
-         * Gets the config for the current instance.
-         * @returns Promise that resolves with the {@link Config} object.
-         */
-        function getConfig() {
-            return new Promise(function (resolve) {
-                ensureInitialized(FrameContexts.content, FrameContexts.settings, FrameContexts.remove, FrameContexts.sidePanel);
-                resolve(sendAndUnwrap('settings.getSettings'));
-            });
-        }
-        config.getConfig = getConfig;
         /**
          * Sets the config for the current instance.
          * This is an asynchronous operation; calls to getConfig are not guaranteed to reflect the changed state.
-         * @param Config The desired config for this instance.
+         * @param instanceConfig The desired config for this instance.
          * @returns Promise that resolves when the operation has completed.
          */
-        function setConfig(instanceSettings) {
+        function setConfig(instanceConfig) {
             return new Promise(function (resolve) {
                 ensureInitialized(FrameContexts.content, FrameContexts.settings, FrameContexts.sidePanel);
-                resolve(sendAndHandleStatusAndReason('settings.setSettings', instanceSettings));
+                resolve(sendAndHandleStatusAndReason('settings.setSettings', instanceConfig));
             });
         }
         config.setConfig = setConfig;
@@ -5241,7 +5241,7 @@ var settings;
      */
     function getSettings(callback) {
         ensureInitialized(FrameContexts.content, FrameContexts.settings, FrameContexts.remove, FrameContexts.sidePanel);
-        pages.config.getConfig().then(function (config) {
+        pages.getConfig().then(function (config) {
             callback(config);
         });
     }