@microsoft/teams-js
Version:
Microsoft Client SDK for building app for Microsoft hosts
48 lines (47 loc) • 1.5 kB
TypeScript
/**
* Module to get the list of content shared in a Teams meeting
*
* @beta
* @module
*/
/**
* Represents the data returned when calling {@link sharing.history.getContent}
*
* @beta
*/
export interface IContentResponse {
/** Id of the app where the content was shared from */
appId: string;
/** Title of the shared content */
title: string;
/** Reference of the shared content */
contentReference: string;
/** Id of the thread where the content was shared. */
threadId: string;
/** Id of the user who shared the content. */
author: string;
/** Type of the shared content.
* For sharing to Teams stage scenarios, this value would be `ShareToStage`
* Other `contentType` values will be added and documented here over time
*/
contentType: string;
}
/**
* Get the list of content shared in a Teams meeting
*
* @throws Error if call capability is not supported
* @throws Error if returned content details are invalid
* @returns Promise that will resolve with the {@link IContentResponse} objects array
*
* @beta
*/
export declare function getContent(): Promise<IContentResponse[]>;
/**
* Checks if sharing.history capability is supported by the host
* @returns boolean to represent whether the sharing.history capability is supported
*
* @throws Error if {@linkcode app.initialize} has not successfully completed
*
* @beta
*/
export declare function isSupported(): boolean;