@microsoft/agents-hosting-extensions-teams/dist/src/messageExtension/messagingExtensionResult.d.ts

Microsoft 365 Agents SDK for JavaScript. Teams extensions

/**
 * Copyright(c) Microsoft Corporation.All rights reserved.
 * Licensed under the MIT License.
 */
import { Activity } from '@microsoft/agents-activity';
import { MessagingExtensionAttachment } from './messagingExtensionAttachment';
import { MessagingExtensionSuggestedAction } from './messagingExtensionSuggestedAction';
/**
 * Layout options for attachments.
 */
export type AttachmentLayout = 'list' | 'grid';
/**
 * Types of messaging extension results.
 * - `result`: Represents a standard result.
 * - `auth`: Represents an authentication request.
 * - `config`: Represents a configuration request.
 * - `message`: Represents a message result.
 * - `botMessagePreview`: Represents a bot message preview.
 * - `silentAuth`: Represents a silent authentication request.
 */
export type MessagingExtensionResultType = 'result' | 'auth' | 'config' | 'message' | 'botMessagePreview' | 'silentAuth';
/**
 * Represents the result of a messaging extension.
 */
export interface MessagingExtensionResult {
    /**
     * The layout of the attachments.
     */
    attachmentLayout?: AttachmentLayout;
    /**
     * The type of the result.
     */
    type?: MessagingExtensionResultType;
    /**
     * A list of attachments.
     */
    attachments?: MessagingExtensionAttachment[];
    /**
     * Suggested actions for the result.
     */
    suggestedActions?: MessagingExtensionSuggestedAction;
    /**
     * Text content of the result.
     */
    text?: string;
    /**
     * Preview of the activity.
     */
    activityPreview?: Activity;
}