@microsoft/teams-js 2.0.0-beta.6-dev.7 → 2.0.0-beta.6-dev.8

package/dist/MicrosoftTeams.d.ts

@@ -3448,7 +3448,8 @@ export namespace menus {
 }
 
 /**
-    * @alpha
+    * @deprecated
+    * As of 2.0.0-beta.6, use media only for backwards compatibility of existing code.
     */
 export namespace media {
         /**
@@ -3486,29 +3487,19 @@ export namespace media {
                 name?: string;
         }
         /**
-            * Launch camera, capture image or choose image from gallery and return the images as a File[] object
-            *
-            * @remarks
-            * Note: Currently we support getting one File through this API, i.e. the file arrays size will be one.
-            * Note: For desktop, this API is not supported. Promise will be rejected with ErrorCode.NotSupported.
-            *
-            * @returns A promise resolved with a collection of @see File objects or rejected with an @see SdkError
-            */
-        export function captureImage(): Promise<File[]>;
-        /**
-            * Launch camera, capture image or choose image from gallery and return the images as a File[] object
-            *
-            * @param callback - Callback to invoke when the image is captured.
-            *
             * @deprecated
-            * As of 2.0.0-beta.1, please use {@link media.captureImage media.captureImage(): Promise\<File[]\>} instead.
+            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
             *
+            * Launch camera, capture image or choose image from gallery and return the images as a File[] object to the callback.
+            *
+            * @params callback - Callback will be called with an @see SdkError if there are any.
+            * If error is null or undefined, the callback will be called with a collection of @see File objects
             * @remarks
             * Note: Currently we support getting one File through this API, i.e. the file arrays size will be one.
             * Note: For desktop, this API is not supported. Callback will be resolved with ErrorCode.NotSupported.
             *
             */
-        export function captureImage(callback: (error?: SdkError, files?: File[]) => void): void;
+        export function captureImage(callback: (error: SdkError, files: File[]) => void): void;
         /**
             * Media object returned by the select Media API
             */
@@ -3521,17 +3512,8 @@ export namespace media {
                 preview: string;
                 /**
                     * Gets the media in chunks irrespective of size, these chunks are assembled and sent back to the webapp as file/blob
-                    *
-                    * @returns A promise resolved with the @see Blob or rejected with a @see SdkError
-                    */
-                getMedia(): Promise<Blob>;
-                /**
-                    * Gets the media in chunks irrespective of size, these chunks are assembled and sent back to the webapp as file/blob
-                    *
-                    * @deprecated
-                    * As of 2.0.0-beta.1, please use {@link media.Media.getMedia media.Media.getMedia(): Promise\<Blob\>} instead.
-                    *
-                    * @param callback - returns blob of media
+                    * @param callback - callback is called with the @see SdkError if there is an error
+                    * If error is null or undefined, the callback will be called with @see Blob.
                     */
                 getMedia(callback: (error: SdkError, blob: Blob) => void): void;
         }
@@ -3664,7 +3646,7 @@ export namespace media {
             */
         abstract class MediaController<T> {
                 protected controllerCallback: T;
-                constructor(controllerCallback: T);
+                constructor(controllerCallback?: T);
                 protected abstract getMediaType(): MediaType;
                 /**
                     * @hidden
@@ -3679,20 +3661,6 @@ export namespace media {
                     * @hidden
                     * Hide from docs
                     * --------
-                    *
-                    * Function to notify the host client to programatically control the experience
-                    * @param mediaEvent indicates what the event that needs to be signaled to the host client
-                    * @returns A promise resolved promise
-                    */
-                protected notifyEventToHost(mediaEvent: MediaControllerEvent): Promise<void>;
-                /**
-                    * @hidden
-                    * Hide from docs
-                    * --------
-                    *
-                    * @deprecated
-                    * As of 2.0.0-beta.3, please use {@link media.MediaController.notifyEventToHost media.MediaController.notifyEventToHost(mediaEvent: MediaControllerEvent): Promise\<void\>} instead.
-                    *
                     * Function to notify the host client to programatically control the experience
                     * @param mediaEvent indicates what the event that needs to be signaled to the host client
                     * Optional; @param callback is used to send app if host client has successfully handled the notification event or not
@@ -3700,17 +3668,6 @@ export namespace media {
                 protected notifyEventToHost(mediaEvent: MediaControllerEvent, callback?: (err?: SdkError) => void): void;
                 /**
                     * Function to programatically stop the ongoing media event
-                    *
-                    * @returns A resolved promise
-                    * */
-                stop(): Promise<void>;
-                /**
-                    *
-                    * Function to programatically stop the ongoing media event
-                    *
-                    * @deprecated
-                    * As of 2.0.0-beta.3, please use {@link media.MediaController.stop media.MediaController.stop(): Promise\<void\>} instead.
-                    *
                     * Optional; @param callback is used to send app if host client has successfully stopped the event or not
                     */
                 stop(callback?: (err?: SdkError) => void): void;
@@ -3719,8 +3676,7 @@ export namespace media {
             * Callback which will register your app to listen to lifecycle events during the video capture flow
             */
         export interface VideoControllerCallback {
-                onRecordingStarted(): void;
-                onRecordingStopped?(): void;
+                onRecordingStarted?(): void;
         }
         /**
             * VideoController class is used to communicate between the app and the host client during the video capture flow
@@ -3819,39 +3775,24 @@ export namespace media {
                 file: Blob;
         }
         /**
-            * Select an attachment using camera/gallery
+            * @deprecated
+            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
             *
-            * @param mediaInputs - The input params to customize the media to be selected
-            * @returns  A promise resolved with an array of media data or rejected with an @see SdkError
-            */
-        export function selectMedia(mediaInputs: MediaInputs): Promise<Media[]>;
-        /**
             * Select an attachment using camera/gallery
             *
-            * @deprecated
-            * As of 2.0.0-beta.1, please use {@link media.selectMedia media.selectMedia(mediaInputs: MediaInputs): Promise\<Media[]\>} instead.
-            *
             * @param mediaInputs - The input params to customize the media to be selected
             * @param callback - The callback to invoke after fetching the media
             */
-        export function selectMedia(mediaInputs: MediaInputs, callback: (error: SdkError, attachments: Media[]) => void): any;
-        /**
-            * View images using native image viewer
-            *
-            * @param uriList - list of URIs for images to be viewed - can be content URI or server URL. Supports up to 10 Images in a single call
-            * @returns A promise resolved when the viewing action is completed or rejected with an @see SdkError
-            */
-        export function viewImages(uriList: ImageUri[]): Promise<void>;
+        export function selectMedia(mediaInputs: MediaInputs, callback: (error: SdkError, attachments: Media[]) => void): void;
         /**
-            * View images using native image viewer
-            *
             * @deprecated
-            * As of 2.0.0-beta.1, please use {@link media.viewImages media.viewImages(uriList: ImageUri[]): Promise\<void\>} instead.
+            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
             *
+            * View images using native image viewer
             * @param uriList - list of URIs for images to be viewed - can be content URI or server URL. Supports up to 10 Images in a single call
             * @param callback - returns back error if encountered, returns null in case of success
             */
-        export function viewImages(uriList: ImageUri[], callback: (error?: SdkError) => void): any;
+        export function viewImages(uriList: ImageUri[], callback: (error?: SdkError) => void): void;
         /**
             * Barcode configuration supplied to scanBarCode API to customize barcode scanning experience in mobile
             * All properties in BarCodeConfig are optional and have default values in the platform
@@ -3864,29 +3805,17 @@ export namespace media {
                 timeOutIntervalInSec?: number;
         }
         /**
-            * Scan Barcode/QRcode using camera
-            *
-            * @remarks
-            * Note: For desktop and web, this API is not supported. Callback will be resolved with ErrorCode.NotSupported.
+            * @deprecated
+            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
             *
-            * @param config - optional input configuration to customize the barcode scanning experience
-            * @returns A promise resolved with the barcode data or rejected with an @see SdkError
-            */
-        export function scanBarCode(config?: BarCodeConfig): Promise<string>;
-        /**
             * Scan Barcode/QRcode using camera
-            *
             * @remarks
             * Note: For desktop and web, this API is not supported. Callback will be resolved with ErrorCode.NotSupported.
             *
-            * @deprecated
-            * As of 2.0.0-beta.1, please use {@link media.scanBarCode media.scanBarCode(config?: BarCodeConfig): Promise\<string\>} instead.
-            *
             * @param callback - callback to invoke after scanning the barcode
             * @param config - optional input configuration to customize the barcode scanning experience
             */
-        export function scanBarCode(callback: (error: SdkError, decodedText: string) => void, config?: BarCodeConfig): any;
-        export function isSupported(): boolean;
+        export function scanBarCode(callback: (error: SdkError, decodedText: string) => void, config?: BarCodeConfig): void;
         export {};
 }