@microsoft/teams-js 1.10.1-dev.0 → 1.10.1-dev.1

package/dts/public/media.d.ts

@@ -0,0 +1,219 @@
+import { SdkError } from './interfaces';
+export declare namespace media {
+    /**
+     * Enum for file formats supported
+     */
+    enum FileFormat {
+        Base64 = "base64",
+        ID = "id"
+    }
+    /**
+     * File object that can be used to represent image or video or audio
+     */
+    class File {
+        /**
+         * Content of the file. When format is Base64, this is the base64 content
+         * When format is ID, this is id mapping to the URI
+         * When format is base64 and app needs to use this directly in HTML tags, it should convert this to dataUrl.
+         */
+        content: string;
+        /**
+         * Format of the content
+         */
+        format: FileFormat;
+        /**
+         * Size of the file in KB
+         */
+        size: number;
+        /**
+         * MIME type. This can be used for constructing a dataUrl, if needed.
+         */
+        mimeType: string;
+        /**
+         * Optional: Name of the file
+         */
+        name?: string;
+    }
+    /**
+     * Launch camera, capture image or choose image from gallery and return the images as a File[] object to the callback.
+     * Callback will be called with an error, if there are any. App should first check the error.
+     * If it is present the user can be updated with appropriate error message.
+     * If error is null or undefined, then files will have the required result.
+     * 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.
+     * @see File
+     * @see SdkError
+     */
+    function captureImage(callback: (error: SdkError, files: File[]) => void): void;
+    /**
+     * Media object returned by the select Media API
+     */
+    class Media extends File {
+        constructor(that?: Media);
+        /**
+         * A preview of the file which is a lightweight representation.
+         * In case of images this will be a thumbnail/compressed image in base64 encoding.
+         */
+        preview: string;
+        /**
+         * Gets the media in chunks irrespecitve of size, these chunks are assembled and sent back to the webapp as file/blob
+         * @param callback returns blob of media
+         */
+        getMedia(callback: (error: SdkError, blob: Blob) => void): void;
+        private getMediaViaCallback;
+        private getMediaViaHandler;
+    }
+    /**
+     * Input parameter supplied to the select Media API
+     */
+    interface MediaInputs {
+        /**
+         * Only one media type can be selected at a time
+         */
+        mediaType: MediaType;
+        /**
+         * max limit of media allowed to be selected in one go, current max limit is 10 set by office lens.
+         */
+        maxMediaCount: number;
+        /**
+         * Additional properties for customization of select media in mobile devices
+         */
+        imageProps?: ImageProps;
+        /**
+         * Additional properties for audio capture flows.
+         */
+        audioProps?: AudioProps;
+    }
+    /**
+     *  All properties in ImageProps are optional and have default values in the platform
+     */
+    interface ImageProps {
+        /**
+         * Optional; Lets the developer specify the image source, more than one can be specified.
+         * Default value is both camera and gallery
+         */
+        sources?: Source[];
+        /**
+         * Optional; Specify in which mode the camera will be opened.
+         * Default value is Photo
+         */
+        startMode?: CameraStartMode;
+        /**
+         * Optional; indicate if inking on the selected Image is allowed or not
+         * Default value is true
+         */
+        ink?: boolean;
+        /**
+         * Optional; indicate if user is allowed to move between front and back camera
+         * Default value is true
+         */
+        cameraSwitcher?: boolean;
+        /**
+         * Optional; indicate if putting text stickers on the selected Image is allowed or not
+         * Default value is true
+         */
+        textSticker?: boolean;
+        /**
+         * Optional; indicate if image filtering mode is enabled on the selected image
+         * Default value is false
+         */
+        enableFilter?: boolean;
+    }
+    /**
+     *  All properties in AudioProps are optional and have default values in the platform
+     */
+    interface AudioProps {
+        /**
+         * Optional; the maximum duration in minutes after which the recording should terminate automatically.
+         * Default value is defined by the platform serving the API.
+         */
+        maxDuration?: number;
+    }
+    /**
+     * The modes in which camera can be launched in select Media API
+     */
+    enum CameraStartMode {
+        Photo = 1,
+        Document = 2,
+        Whiteboard = 3,
+        BusinessCard = 4
+    }
+    /**
+     * Specifies the image source
+     */
+    enum Source {
+        Camera = 1,
+        Gallery = 2
+    }
+    /**
+     * Specifies the type of Media
+     */
+    enum MediaType {
+        Image = 1,
+        Audio = 4
+    }
+    /**
+     * Input for view images API
+     */
+    interface ImageUri {
+        value: string;
+        type: ImageUriType;
+    }
+    /**
+     * ID contains a mapping for content uri on platform's side, URL is generic
+     */
+    enum ImageUriType {
+        ID = 1,
+        URL = 2
+    }
+    /**
+     * Media chunks an output of getMedia API from platform
+     */
+    interface MediaChunk {
+        /**
+         * Base 64 data for the requested uri
+         */
+        chunk: string;
+        /**
+         * chunk sequence number​
+         */
+        chunkSequence: number;
+    }
+    /**
+     * Helper object to assembled media chunks
+     */
+    interface AssembleAttachment {
+        sequence: number;
+        file: Blob;
+    }
+    /**
+     * Select an attachment using camera/gallery
+     * @param mediaInputs The input params to customize the media to be selected
+     * @param callback The callback to invoke after fetching the media
+     */
+    function selectMedia(mediaInputs: MediaInputs, callback: (error: SdkError, attachments: Media[]) => void): void;
+    /**
+     * View images using native image viewer
+     * @param uriList urilist of images to be viewed - can be content uri or server url. supports upto 10 Images in one go
+     * @param callback returns back error if encountered, returns null in case of success
+     */
+    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
+     */
+    interface BarCodeConfig {
+        /**
+         * Optional; Lets the developer specify the scan timeout interval in seconds
+         * Default value is 30 seconds and max allowed value is 60 seconds
+         */
+        timeOutIntervalInSec?: number;
+    }
+    /**
+     * Scan Barcode/QRcode using camera
+     * Note: For desktop and web, this API is not supported. Callback will be resolved with ErrorCode.NotSupported.
+     * @param callback callback to invoke after scanning the barcode
+     * @param config optional input configuration to customize the barcode scanning experience
+     */
+    function scanBarCode(callback: (error: SdkError, decodedText: string) => void, config?: BarCodeConfig): void;
+}

package/dts/public/meeting.d.ts

@@ -0,0 +1,158 @@
+import { SdkError } from './interfaces';
+export declare namespace meeting {
+    /**
+     * @private
+     * Hide from docs
+     * Data structure to represent a meeting details.
+     */
+    interface IMeetingDetails {
+        /**
+         * details object
+         */
+        details: IDetails;
+        /**
+         * conversation object
+         */
+        conversation: IConversation;
+        /**
+         * organizer object
+         */
+        organizer: IOrganizer;
+    }
+    /**
+     * @private
+     * Hide from docs
+     * Data structure to represent details.
+     */
+    interface IDetails {
+        /**
+         * Scheduled start time of the meeting
+         */
+        scheduledStartTime: string;
+        /**
+         * Scheduled end time of the meeting
+         */
+        scheduledEndTime: string;
+        /**
+         * url to join the current meeting
+         */
+        joinUrl?: string;
+        /**
+         * meeting title name of the meeting
+         */
+        title?: string;
+        /**
+         * type of the meeting
+         */
+        type?: MeetingType;
+    }
+    /**
+     * @private
+     * Hide from docs
+     * Data structure to represent a conversation object.
+     */
+    interface IConversation {
+        /**
+         * conversation id of the meeting
+         */
+        id: string;
+    }
+    /**
+     * @private
+     * Hide from docs
+     * Data structure to represent an organizer object.
+     */
+    interface IOrganizer {
+        /**
+         * organizer id of the meeting
+         */
+        id?: string;
+        /**
+         * tenant id of the meeting
+         */
+        tenantId?: string;
+    }
+    interface LiveStreamState {
+        /**
+         * indicates whether meeting is streaming
+         */
+        isStreaming: boolean;
+        /**
+         * error object in case there is a failure
+         */
+        error?: {
+            /** error code from the streaming service, e.g. IngestionFailure */
+            code: string;
+            /** detailed error message string */
+            message?: string;
+        };
+    }
+    enum MeetingType {
+        Unknown = "Unknown",
+        Adhoc = "Adhoc",
+        Scheduled = "Scheduled",
+        Recurring = "Recurring",
+        Broadcast = "Broadcast",
+        MeetNow = "MeetNow"
+    }
+    /**
+     * Allows an app to get the incoming audio speaker setting for the meeting user
+     * @param callback Callback contains 2 parameters, error and result.
+     * error can either contain an error of type SdkError, incase of an error, or null when fetch is successful
+     * result can either contain the true/false value, incase of a successful fetch or null when the fetching fails
+     * result: True means incoming audio is muted and false means incoming audio is unmuted
+     */
+    function getIncomingClientAudioState(callback: (error: SdkError | null, result: boolean | null) => void): void;
+    /**
+     * Allows an app to toggle the incoming audio speaker setting for the meeting user from mute to unmute or vice-versa
+     * @param callback Callback contains 2 parameters, error and result.
+     * error can either contain an error of type SdkError, incase of an error, or null when toggle is successful
+     * result can either contain the true/false value, incase of a successful toggle or null when the toggling fails
+     * result: True means incoming audio is muted and false means incoming audio is unmuted
+     */
+    function toggleIncomingClientAudio(callback: (error: SdkError | null, result: boolean | null) => void): void;
+    /**
+     * @private
+     * Hide from docs
+     * Allows an app to get the meeting details for the meeting
+     * @param callback Callback contains 2 parameters, error and meetingDetails.
+     * error can either contain an error of type SdkError, incase of an error, or null when get is successful
+     * result can either contain a IMeetingDetails value, incase of a successful get or null when the get fails
+     */
+    function getMeetingDetails(callback: (error: SdkError | null, meetingDetails: IMeetingDetails | null) => void): void;
+    /**
+     * @private
+     * Allows an app to get the authentication token for the anonymous or guest user in the meeting
+     * @param callback Callback contains 2 parameters, error and authenticationTokenOfAnonymousUser.
+     * error can either contain an error of type SdkError, incase of an error, or null when get is successful
+     * authenticationTokenOfAnonymousUser can either contain a string value, incase of a successful get or null when the get fails
+     */
+    function getAuthenticationTokenForAnonymousUser(callback: (error: SdkError | null, authenticationTokenOfAnonymousUser: string | null) => void): void;
+    /**
+     * Allows an app to get the state of the live stream in the current meeting
+     * @param callback Callback contains 2 parameters: error and liveStreamState.
+     * error can either contain an error of type SdkError, in case of an error, or null when get is successful
+     * liveStreamState can either contain a LiveStreamState value, or null when operation fails
+     */
+    function getLiveStreamState(callback: (error: SdkError | null, liveStreamState: LiveStreamState | null) => void): void;
+    /**
+     * Allows an app to request the live streaming be started at the given streaming url
+     * @param streamUrl the url to the stream resource
+     * @param streamKey the key to the stream resource
+     * @param callback Callback contains error parameter which can be of type SdkError in case of an error, or null when operation is successful
+     * Use getLiveStreamState or registerLiveStreamChangedHandler to get updates on the live stream state
+     */
+    function requestStartLiveStreaming(callback: (error: SdkError | null) => void, streamUrl: string, streamKey?: string): void;
+    /**
+     * Allows an app to request the live streaming be stopped at the given streaming url
+     * @param callback Callback contains error parameter which can be of type SdkError in case of an error, or null when operation is successful
+     * Use getLiveStreamState or registerLiveStreamChangedHandler to get updates on the live stream state
+     */
+    function requestStopLiveStreaming(callback: (error: SdkError | null) => void): void;
+    /**
+     * Registers a handler for changes to the live stream.
+     * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+     * @param handler The handler to invoke when the live stream state changes
+     */
+    function registerLiveStreamChangedHandler(handler: (liveStreamState: LiveStreamState) => void): void;
+}

package/dts/public/navigation.d.ts

@@ -0,0 +1,28 @@
+import { TabInstance } from './interfaces';
+/**
+ * Navigation specific part of the SDK.
+ */
+/**
+ * Return focus to the main Teams app. Will focus search bar if navigating foward and app bar if navigating back.
+ * @param navigateForward Determines the direction to focus in teams app.
+ */
+export declare function returnFocus(navigateForward?: boolean): void;
+/**
+ * Navigates the Microsoft Teams app to the specified tab instance.
+ * @param tabInstance The tab instance to navigate to.
+ */
+export declare function navigateToTab(tabInstance: TabInstance, onComplete?: (status: boolean, reason?: string) => void): void;
+/**
+ * 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
+ * thrown. This function needs to be used only when navigating the frame to a URL in a different domain
+ * than the current one in a way that keeps the app informed of the change and allows the SDK to
+ * continue working.
+ * @param url The URL to navigate the frame to.
+ */
+export declare function navigateCrossDomain(url: string, onComplete?: (status: boolean, reason?: string) => void): void;
+/**
+ * Navigates back in the Teams client. See registerBackButtonHandler for more information on when
+ * it's appropriate to use this method.
+ */
+export declare function navigateBack(onComplete?: (status: boolean, reason?: string) => void): void;

package/dts/public/people.d.ts

@@ -0,0 +1,53 @@
+import { SdkError } from './interfaces';
+export declare namespace people {
+    /**
+     * Launches a people picker and allows the user to select one or more people from the list
+     * If the app is added to personal app scope the people picker launched is org wide and if the app is added to a chat/channel, people picker launched is also limited to the members of chat/channel
+     * @param callback Returns list of JSON object of type PeoplePickerResult which consists of AAD IDs, display names and emails of the selected users
+     * @param peoplePickerInputs Input parameters to launch customized people picker
+     */
+    function selectPeople(callback: (error: SdkError, people: PeoplePickerResult[]) => void, peoplePickerInputs?: PeoplePickerInputs): void;
+    /**
+     * Input parameter supplied to the People Picker API
+     */
+    interface PeoplePickerInputs {
+        /**
+         * Optional; Set title for the people picker
+         * Default value is "Select people" for multiselect and "Select a person" for single select
+         */
+        title?: string;
+        /**
+         * Optional; AAD ids of the users to be pre-populated in the search box of people picker control
+         * If single select is enabled this value, only the first user in the list will be pre-populated
+         * Default value is null
+         */
+        setSelected?: string[];
+        /**
+         * Optional; launches the people picker in org wide scope even if the app is added to a chat or channel
+         * Default value is false
+         */
+        openOrgWideSearchInChatOrChannel?: boolean;
+        /**
+         * Optional; launches the people picker for which only 1 person can be selected
+         * Default value is false
+         */
+        singleSelect?: boolean;
+    }
+    /**
+     * Output user object of people picker API
+     */
+    interface PeoplePickerResult {
+        /**
+         * user object Id (also known as aad id) of the selected user
+         */
+        objectId: string;
+        /**
+         * Optional; display name of the selected user
+         */
+        displayName?: string;
+        /**
+         * Optional; email of the selected user
+         */
+        email?: string;
+    }
+}

package/dts/public/publicAPIs.d.ts

@@ -0,0 +1,117 @@
+import { TabInformation, TabInstanceParameters, DeepLinkParameters, Context, LoadContext, FrameContext } from './interfaces';
+/**
+ * Initializes the library. This must be called before any other SDK calls
+ * but after the frame is loaded successfully.
+ * @param callback Optionally specify a callback to invoke when Teams SDK has successfully initialized
+ * @param validMessageOrigins Optionally specify a list of cross frame message origins. There must have
+ * https: protocol otherwise they will be ignored. Example: https://www.example.com
+ */
+export declare function initialize(callback?: () => void, validMessageOrigins?: string[]): void;
+/**
+ * @private
+ * Hide from docs.
+ * ------
+ * Undocumented function used to set a mock window for unit tests
+ */
+export declare function _initialize(hostWindow: any): void;
+/**
+ * @private
+ * Hide from docs.
+ * ------
+ * Undocumented function used to clear state between unit tests
+ */
+export declare function _uninitialize(): void;
+/**
+ * Enable print capability to support printing page using Ctrl+P and cmd+P
+ */
+export declare function enablePrintCapability(): void;
+/**
+ * default print handler
+ */
+export declare function print(): void;
+/**
+ * Retrieves the current context the frame is running in.
+ * @param callback The callback to invoke when the {@link Context} object is retrieved.
+ */
+export declare function getContext(callback: (context: Context) => void): void;
+/**
+ * Registers a handler for theme changes.
+ * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+ * @param handler The handler to invoke when the user changes their theme.
+ */
+export declare function registerOnThemeChangeHandler(handler: (theme: string) => void): void;
+/**
+ * Registers a handler for changes from or to full-screen view for a tab.
+ * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+ * @param handler The handler to invoke when the user toggles full-screen view for a tab.
+ */
+export declare function registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void;
+/**
+ * Registers a handler for clicking the app button.
+ * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+ * @param handler The handler to invoke when the personal app button is clicked in the app bar.
+ */
+export declare function registerAppButtonClickHandler(handler: () => void): void;
+/**
+ * Registers a handler for entering hover of the app button.
+ * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+ * @param handler The handler to invoke when entering hover of the personal app button in the app bar.
+ */
+export declare function registerAppButtonHoverEnterHandler(handler: () => void): void;
+/**
+ * Registers a handler for exiting hover of the app button.
+ * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+ * @param handler The handler to invoke when exiting hover of the personal app button in the app bar.
+ */
+export declare function registerAppButtonHoverLeaveHandler(handler: () => void): void;
+/**
+ * Registers a handler for user presses of the Team client's back button. Experiences that maintain an internal
+ * navigation stack should use this handler to navigate the user back within their frame. If an app finds
+ * that after running its back button handler it cannot handle the event it should call the navigateBack
+ * method to ask the Teams client to handle it instead.
+ * @param handler The handler to invoke when the user presses their Team client's back button.
+ */
+export declare function registerBackButtonHandler(handler: () => boolean): void;
+/**
+ * @private
+ * Registers a handler to be called when the page has been requested to load.
+ * @param handler The handler to invoke when the page is loaded.
+ */
+export declare function registerOnLoadHandler(handler: (context: LoadContext) => void): void;
+/**
+ * @private
+ * Registers a handler to be called before the page is unloaded.
+ * @param handler The handler to invoke before the page is unloaded. If this handler returns true the page should
+ * invoke the readyToUnload function provided to it once it's ready to be unloaded.
+ */
+export declare function registerBeforeUnloadHandler(handler: (readyToUnload: () => void) => boolean): void;
+/**
+ * Registers a handler for when the user reconfigurated tab
+ * @param handler The handler to invoke when the user click on Settings.
+ */
+export declare function registerChangeSettingsHandler(handler: () => void): void;
+/**
+ * Allows an app to retrieve for this user tabs that are owned by this app.
+ * If no TabInstanceParameters are passed, the app defaults to favorite teams and favorite channels.
+ * @param callback The callback to invoke when the {@link TabInstanceParameters} object is retrieved.
+ * @param tabInstanceParameters OPTIONAL Flags that specify whether to scope call to favorite teams or channels.
+ */
+export declare function getTabInstances(callback: (tabInfo: TabInformation) => void, tabInstanceParameters?: TabInstanceParameters): void;
+/**
+ * Allows an app to retrieve the most recently used tabs for this user.
+ * @param callback The callback to invoke when the {@link TabInformation} object is retrieved.
+ * @param tabInstanceParameters OPTIONAL Ignored, kept for future use
+ */
+export declare function getMruTabInstances(callback: (tabInfo: TabInformation) => void, tabInstanceParameters?: TabInstanceParameters): void;
+/**
+ * Shares a deep link that a user can use to navigate back to a specific state in this page.
+ * @param deepLinkParameters ID and label for the link and fallback URL.
+ */
+export declare function shareDeepLink(deepLinkParameters: DeepLinkParameters): void;
+/**
+ * execute deep link API.
+ * @param deepLink deep link.
+ */
+export declare function executeDeepLink(deepLink: string, onComplete?: (status: boolean, reason?: string) => void): void;
+export declare function setFrameContext(frameContext: FrameContext): void;
+export declare function initializeWithFrameContext(frameContext: FrameContext, callback?: () => void, validMessageOrigins?: string[]): void;

package/dts/public/settings.d.ts

@@ -0,0 +1,95 @@
+/**
+ * Namespace to interact with the settings-specific part of the SDK.
+ * This object is usable only on the settings frame.
+ */
+export declare namespace settings {
+    function initialize(): void;
+    /**
+     * Sets the validity state for the settings.
+     * The initial value is false, so the user cannot save the settings until this is called with true.
+     * @param validityState Indicates whether the save or remove button is enabled for the user.
+     */
+    function setValidityState(validityState: boolean): void;
+    /**
+     * Gets the settings for the current instance.
+     * @param callback The callback to invoke when the {@link Settings} object is retrieved.
+     */
+    function getSettings(callback: (instanceSettings: Settings) => void): void;
+    /**
+     * Sets the settings for the current instance.
+     * This is an asynchronous operation; calls to getSettings are not guaranteed to reflect the changed state.
+     * @param settings The desired settings for this instance.
+     */
+    function setSettings(instanceSettings: Settings, onComplete?: (status: boolean, reason?: string) => void): 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.
+     * The object passed to the handler must be used to notify whether to proceed with the save.
+     * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+     * @param handler The handler to invoke when the user selects the save button.
+     */
+    function registerOnSaveHandler(handler: (evt: SaveEvent) => void): void;
+    /**
+     * Registers a handler for user attempts to remove content. This handler should be used
+     * to remove the underlying resource powering the content.
+     * The object passed to the handler must be used to indicate whether to proceed with the removal.
+     * Only one handler may be registered at a time. Subsequent registrations will override the first.
+     * @param handler The handler to invoke when the user selects the remove button.
+     */
+    function registerOnRemoveHandler(handler: (evt: RemoveEvent) => void): void;
+    interface Settings {
+        /**
+         * 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.
+         */
+        result: SaveParameters;
+        /**
+         * Indicates that the underlying resource has been created and the settings can be saved.
+         */
+        notifySuccess(): void;
+        /**
+         * Indicates that creation of the underlying resource failed and that the settings cannot be saved.
+         * @param reason Specifies a reason for the failure. If provided, this string is displayed to the user; otherwise a generic error is displayed.
+         */
+        notifyFailure(reason?: string): void;
+    }
+    interface RemoveEvent {
+        /**
+         * Indicates that the underlying resource has been removed and the content can be removed.
+         */
+        notifySuccess(): void;
+        /**
+         * Indicates that removal of the underlying resource failed and that the content cannot be removed.
+         * @param reason Specifies a reason for the failure. If provided, this string is displayed to the user; otherwise a generic error is displayed.
+         */
+        notifyFailure(reason?: string): void;
+    }
+    interface SaveParameters {
+        /**
+         * Connector's webhook Url returned as arguments to settings.save event as part of user clicking on Save
+         */
+        webhookUrl?: string;
+    }
+}