@microsoft/teams.api
Version:
<p> <a href="https://www.npmjs.com/package/@microsoft/teams.api" target="_blank"> <img src="https://img.shields.io/npm/v/@microsoft/teams.api/latest" /> </a> <a href="https://www.npmjs.com/package/@microsoft/teams.api?activeTab=code" t
68 lines (65 loc) • 1.97 kB
TypeScript
import { Attachment } from '../attachment/attachment.js';
/**
*
* An interface representing BaseTaskModuleTaskInfo.
*
*/
type BaseTaskModuleTaskInfo = {
/**
* @member {string} [title] Appears below the app name and to the right of
* the app icon.
*/
title?: string;
/**
* @member {number | 'small' | 'medium' | 'large'} [height] This can be a number, representing the task
* module's height in pixels, or a string, one of: small, medium, large.
*/
height?: number | 'small' | 'medium' | 'large';
/**
* @member {number | 'small' | 'medium' | 'large'} [width] This can be a number, representing the task module's
* width in pixels, or a string, one of: small, medium, large.
*/
width?: number | 'small' | 'medium' | 'large';
/**
* @member {string} [fallbackUrl] If a client does not support the task
* module feature, this URL is opened in a browser tab.
*/
fallbackUrl?: string;
/**
* @member {string} [completionBotId] If a client does not support the task
* module feature, this URL is opened in a browser tab.
*/
completionBotId?: string;
};
/**
*
* An interface representing CardTaskModuleTaskInfo.
*
*/
type CardTaskModuleTaskInfo = BaseTaskModuleTaskInfo & {
/**
* @member {Attachment} [card] The JSON for the Adaptive card to appear in
* the task module.
*/
card: Attachment;
};
/**
*
* An interface representing UrlTaskModuleTaskInfo.
*
*/
type UrlTaskModuleTaskInfo = BaseTaskModuleTaskInfo & {
/**
* @member {string} [url] The URL of what is loaded as an iframe inside the
* task module.
*/
url: string;
};
/**
*
* An interface representing TaskModuleTaskInfo.
* Metadata for a Task Module.
*
*/
type TaskModuleTaskInfo = CardTaskModuleTaskInfo | UrlTaskModuleTaskInfo;
export type { BaseTaskModuleTaskInfo, CardTaskModuleTaskInfo, TaskModuleTaskInfo, UrlTaskModuleTaskInfo };