/** * @hidden * Module to interact with the conversational subEntities inside the tab * * @internal * Limited to Microsoft-internal use * * @module */ import { ChatMembersInformation } from './interfaces'; export interface OpenConversationRequest { /** * @hidden * The Id of the subEntity where the conversation is taking place * * @internal * Limited to Microsoft-internal use */ subEntityId: string; /** * @hidden * The title of the conversation * * @internal * Limited to Microsoft-internal use */ title: string; /** * @hidden * The Id of the conversation. This is optional and should be specified whenever a previous conversation about a specific sub-entity has already been started before * * @internal * Limited to Microsoft-internal use */ conversationId?: string; /** * @hidden * The Id of the channel. This is optional and should be specified whenever a conversation is started or opened in a personal app scope * * @internal * Limited to Microsoft-internal use */ channelId?: string; /** * @hidden * The entity Id of the tab * * @internal * Limited to Microsoft-internal use */ entityId: string; /** * @hidden * A function that is called once the conversation Id has been created * * @internal * Limited to Microsoft-internal use */ onStartConversation?: (conversationResponse: ConversationResponse) => void; /** * @hidden * A function that is called if the pane is closed * * @internal * Limited to Microsoft-internal use */ onCloseConversation?: (conversationResponse: ConversationResponse) => void; } /** * @hidden * * @internal * Limited to Microsoft-internal use */ export interface ConversationResponse { /** * @hidden * * Limited to Microsoft-internal use * The Id of the subEntity where the conversation is taking place */ subEntityId: string; /** * @hidden * The Id of the conversation. This is optional and should be specified whenever a previous conversation about a specific sub-entity has already been started before * * @internal * Limited to Microsoft-internal use */ conversationId?: string; /** * @hidden * The Id of the channel. This is optional and should be specified whenever a conversation is started or opened in a personal app scope * * @internal * Limited to Microsoft-internal use */ channelId?: string; /** * @hidden * The entity Id of the tab * * @internal * Limited to Microsoft-internal use */ entityId?: string; } /** * @hidden * Hide from docs * -------------- * Allows the user to start or continue a conversation with each subentity inside the tab * * @returns Promise resolved upon completion * * @internal * Limited to Microsoft-internal use */ export declare function openConversation(openConversationRequest: OpenConversationRequest): Promise; /** * @hidden * * Allows the user to close the conversation in the right pane * * @internal * Limited to Microsoft-internal use */ export declare function closeConversation(): void; /** * @hidden * Hide from docs * ------ * Allows retrieval of information for all chat members. * NOTE: This value should be used only as a hint as to who the members are * and never as proof of membership in case your app is being hosted by a malicious party. * * @returns Promise resolved with information on all chat members * * @internal * Limited to Microsoft-internal use */ export declare function getChatMembers(): Promise; /** * Checks if the conversations capability is supported by the host * @returns boolean to represent whether conversations capability is supported * * @throws Error if {@linkcode app.initialize} has not successfully completed * * @internal * Limited to Microsoft-internal use */ export declare function isSupported(): boolean;