@microsoft/teams-js
Version:
Microsoft Client SDK for building app for Microsoft hosts
51 lines (50 loc) • 1.35 kB
TypeScript
/**
* @hidden
* @internal
* @beta
* @module
* Limited to Microsoft-internal use
*
* This capability allows an app to associate apps with a host entity, such as a Teams channel or chat, and configure them as needed.
*/
import * as tab from './tab';
export declare enum AppTypes {
edu = "EDU",
/**
* Enum to indicate apps should be filtered for base Townhall.
*/
baseTownhall = "BASE_TOWNHALL",
/**
* Enum to indicate apps should be filtered for streaming Townhall.
*/
streamingTownhall = "STREAMING_TOWNHALL"
}
/**
* Id of the teams entity like channel, chat
*/
interface TeamsEntityId {
threadId: string;
}
/**
* Id of message in which channel meeting is created
*/
export interface TeamsChannelMeetingEntityIds extends TeamsEntityId {
parentMessageId: string;
}
/**
* Id of the host entity
*/
export type HostEntityIds = TeamsEntityId | TeamsChannelMeetingEntityIds;
/**
* @hidden
* @internal
* @beta
* Limited to Microsoft-internal use
*
* Checks if the hostEntity capability is supported by the host
* @returns boolean to represent whether the hostEntity capability is supported
*
* @throws Error if {@linkcode app.initialize} has not successfully completed
*/
export declare function isSupported(): boolean;
export { tab };