@microsoft/teams.api/dist/models/adaptive-card/adaptive-card-action-response.d.ts

<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

import { IAdaptiveCard } from '@microsoft/teams.cards';
import { HttpError } from '../error.js';
import { OAuthCard } from '../oauth/oauth-card.js';
import '../card/card-action.js';
import '../token/token-post-resource.js';
import '../token-exchange/token-exchange-resource.js';

/**
 * Defines the structure that is returned as the result of an Invoke activity with
 * Name of 'adaptiveCard/action'.
 * https://learn.microsoft.com/en-us/adaptive-cards/authoring-cards/universal-action-model#response-format
 */
type AdaptiveCardActionResponse = AdaptiveCardActionCardResponse | AdaptiveCardActionMessageResponse | AdaptiveCardActionErrorResponse | AdaptiveCardActionLoginResponse | AdaptiveCardActionIncorrectAuthCodeResponse | AdaptiveCardActionPreconditionFailedResponse;
/**
 * The request was successfully processed, and the response includes
 * an Adaptive Card that the client should display in place of the current one
 */
type AdaptiveCardActionCardResponse = {
    /**
     * The Card Action response status code.
     */
    statusCode: 200;
    /**
     * The type of this response.
     */
    type: 'application/vnd.microsoft.card.adaptive';
    /**
     * The card response object.
     */
    value: IAdaptiveCard;
};
/**
 * The request was successfully processed, and the response includes a message that the client should display
 */
type AdaptiveCardActionMessageResponse = {
    /**
     * The Card Action response status code.
     */
    statusCode: 200;
    /**
     * The type of this response.
     */
    type: 'application/vnd.microsoft.activity.message';
    /**
     * the response message.
     */
    value: string;
};
/**
 * `400`: The incoming request was invalid
 * `500`: An unexpected error occurred
 */
type AdaptiveCardActionErrorResponse = {
    /**
     * The Card Action response status code.
     */
    statusCode: 400 | 500;
    /**
     * The type of this response.
     */
    type: 'application/vnd.microsoft.error';
    /**
     * The error response object.
     */
    value: HttpError;
};
/**
 * The client needs to prompt the user to authenticate
 */
type AdaptiveCardActionLoginResponse = {
    /**
     * The Card Action response status code.
     */
    statusCode: 401;
    /**
     * The type of this response.
     */
    type: 'application/vnd.microsoft.activity.loginRequest';
    /**
     * The auth response object.
     */
    value: OAuthCard;
};
/**
 * The authentication state passed by the client was incorrect and authentication failed
 */
type AdaptiveCardActionIncorrectAuthCodeResponse = {
    /**
     * The Card Action response status code.
     */
    statusCode: 401;
    /**
     * The type of this response.
     */
    type: 'application/vnd.microsoft.error.incorrectAuthCode';
    /**
     * The auth response object.
     */
    value: null;
};
/**
 * The SSO authentication flow failed
 */
type AdaptiveCardActionPreconditionFailedResponse = {
    /**
     * The Card Action response status code.
     */
    statusCode: 412;
    /**
     * The type of this response.
     */
    type: 'application/vnd.microsoft.error.preconditionFailed';
    /**
     * The auth response object.
     */
    value: HttpError;
};

export type { AdaptiveCardActionCardResponse, AdaptiveCardActionErrorResponse, AdaptiveCardActionIncorrectAuthCodeResponse, AdaptiveCardActionLoginResponse, AdaptiveCardActionMessageResponse, AdaptiveCardActionPreconditionFailedResponse, AdaptiveCardActionResponse };