@microsoft/teams-js
Version:
Microsoft Client SDK for building app for Microsoft hosts
34 lines (33 loc) • 1.25 kB
TypeScript
/**
* @beta
* @hidden
* User information required by specific apps
* @internal
* Limited to Microsoft-internal use
* @module
*/
import { UUID } from '../../public/uuidObject';
/**
* @hidden
* @internal
* Limited to Microsoft-internal use
* @beta
* @returns boolean to represent whether copilot.customTelemetry capability is supported
*
* @throws Error if {@linkcode app.initialize} has not successfully completed
*/
export declare function isSupported(): boolean;
/**
* Sends custom telemetry data to the host.
*
* @param { UUID } stageNameIdentifier - The stageName UUID identifier for the telemetry data.
* @param { number } [timestamp=getCurrentTimestamp() ?? Date.now()] - The timestamp of the telemetry data. Defaults to the current timestamp.
* @returns { Promise<void> } - promise resolves when the host SDK acknowledges that it has received the message.
* @throws { Error } - Throws an error if the app has not been successfully initialized or the host SDK returns an error as a response to this call
*
* @hidden
* @internal
* Limited to Microsoft-internal use
* @beta
*/
export declare function sendCustomTelemetryData(stageNameIdentifier: UUID, timestamp?: number): Promise<void>;