@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
164 lines (153 loc) • 8.13 kB
TypeScript
import './message-BKfEV_tV.js';
import { Client, ClientOptions } from '@microsoft/teams.common/http';
import { CommandActivity } from './activities/command/index.js';
import { ConversationActivity } from './activities/conversation/index.js';
import { EventActivity } from './activities/event/index.js';
import { IHandoffActivity } from './activities/handoff.js';
import { InstallUpdateActivity } from './activities/install-update/index.js';
import { AdaptiveCardInvokeActivity } from './activities/invoke/adaptive-card/index.js';
import { ConfigInvokeActivity } from './activities/invoke/config/index.js';
import { IExecuteActionInvokeActivity } from './activities/invoke/execute-action.js';
import { IFileConsentInvokeActivity } from './activities/invoke/file-consent.js';
import { IHandoffActionInvokeActivity } from './activities/invoke/handoff-action.js';
import { MessageInvokeActivity } from './activities/invoke/message/index.js';
import { IMessageExtensionAnonQueryLinkInvokeActivity } from './activities/invoke/message-extension/anon-query-link.js';
import { IMessageExtensionCardButtonClickedInvokeActivity } from './activities/invoke/message-extension/card-button-clicked.js';
import { ConversationReference } from './models/conversation/conversation-reference.js';
import { IActivity } from './activities/activity.js';
import { Message } from './models/message/message.js';
import { TaskModuleRequest } from './models/task-module/task-module-request.js';
import { IMessageExtensionQueryInvokeActivity } from './activities/invoke/message-extension/query.js';
import { IMessageExtensionQueryLinkInvokeActivity } from './activities/invoke/message-extension/query-link.js';
import { IMessageExtensionQuerySettingUrlInvokeActivity } from './activities/invoke/message-extension/query-setting-url.js';
import { IMessageExtensionSelectItemInvokeActivity } from './activities/invoke/message-extension/select-item.js';
import { IMessageExtensionSettingInvokeActivity } from './activities/invoke/message-extension/setting.js';
import { SignInInvokeActivity } from './activities/invoke/sign-in/index.js';
import { TabInvokeActivity } from './activities/invoke/tab/index.js';
import { TaskInvokeActivity } from './activities/invoke/task/index.js';
import './activities/invoke/config/config-fetch.js';
import './activities/invoke/config/config-submit.js';
import './activities/invoke/tab/tab-fetch.js';
import './activities/invoke/tab/tab-submit.js';
import './activities/invoke/task/task-fetch.js';
import './activities/invoke/task/task-submit.js';
import './activities/invoke/message/submit-action.js';
import './activities/invoke/sign-in/token-exchange.js';
import './activities/invoke/sign-in/verify-state.js';
import './activities/invoke/adaptive-card/action.js';
import { $MessageActivity } from './activities/message/index.js';
import { ITraceActivity } from './activities/trace.js';
import { ITypingActivity } from './activities/typing.js';
import { IAdaptiveCard } from '@microsoft/teams.cards';
import { Account } from './models/account.js';
import { Resource } from './models/resource.js';
import './activities/message/message-delete.js';
import './activities/message/message-update.js';
import './activities/message/message-reaction.js';
import './activities/event/meeting-end.js';
import './activities/event/meeting-participant-join.js';
import './activities/event/meeting-participant-leave.js';
import './activities/event/meeting-start.js';
import './activities/event/read-receipt.js';
import './activities/conversation/conversation-update.js';
import './activities/conversation/end-of-conversation.js';
import './activities/command/command-result.js';
import './activities/command/command-send.js';
import './activities/install-update/add.js';
import './activities/install-update/remove.js';
interface IMessageExtensionFetchTaskInvokeActivity extends IActivity<'invoke'> {
/**
* The name of the operation associated with an invoke or event activity.
*/
name: 'composeExtension/fetchTask';
/**
* A value that is associated with the activity.
*/
value: MessagingExtensionAction;
/**
* A reference to another conversation or activity.
*/
relatesTo?: ConversationReference;
}
interface IMessageExtensionSubmitActionInvokeActivity extends IActivity<'invoke'> {
/**
* The name of the operation associated with an invoke or event activity.
*/
name: 'composeExtension/submitAction';
/**
* A value that is associated with the activity.
*/
value: MessagingExtensionAction;
/**
* A reference to another conversation or activity.
*/
relatesTo?: ConversationReference;
}
type MessageExtensionInvokeActivity = IMessageExtensionAnonQueryLinkInvokeActivity | IMessageExtensionFetchTaskInvokeActivity | IMessageExtensionCardButtonClickedInvokeActivity | IMessageExtensionQueryLinkInvokeActivity | IMessageExtensionQuerySettingUrlInvokeActivity | IMessageExtensionQueryInvokeActivity | IMessageExtensionSelectItemInvokeActivity | IMessageExtensionSettingInvokeActivity | IMessageExtensionSubmitActionInvokeActivity;
type InvokeActivity = IFileConsentInvokeActivity | IExecuteActionInvokeActivity | MessageExtensionInvokeActivity | ConfigInvokeActivity | TabInvokeActivity | TaskInvokeActivity | MessageInvokeActivity | IHandoffActionInvokeActivity | SignInInvokeActivity | AdaptiveCardInvokeActivity;
/**
* @hidden
* @internal
*
* Transforms supported send types into a valid `ActivityParams` object
*/
declare function toActivityParams(activity: ActivityLike): ActivityParams;
type Activity = $MessageActivity | EventActivity | InvokeActivity | ITraceActivity | ITypingActivity | IHandoffActivity | ConversationActivity | CommandActivity | InstallUpdateActivity;
/**
*
* An interface representing MessagingExtensionAction.
* Messaging extension action
*
* @extends TaskModuleRequest
*/
type MessagingExtensionAction = TaskModuleRequest & {
/**
* @member {string} [commandId] Id of the command assigned by Bot
*/
commandId?: string;
/**
* @member {CommandContext} [commandContext] The context from which the
* command originates. Possible values include: 'message', 'compose',
* 'commandbox'
*/
commandContext: 'message' | 'compose' | 'commandbox';
/**
* @member {BotMessagePreviewActionType} [botMessagePreviewAction] Bot message
* preview action taken by user. Possible values include: 'edit', 'send'
*/
botMessagePreviewAction: 'edit' | 'send';
/**
* @member {Activity[]} [botActivityPreview]
*/
botActivityPreview?: Activity[];
/**
* @member {MessageActionsPayload} [messagePayload] Message content sent as
* part of the command request.
*/
messagePayload?: Message;
};
/**
* represents anything that can be transformed
* into an activity in an automated way
*/
type ActivityLike = ActivityParams | string | IAdaptiveCard;
/**
* represents an activity that was sent
*/
type SentActivity = {
id: string;
} & ActivityParams;
type ActivityParams = Pick<Activity, 'type'> & Partial<Activity>;
declare class ConversationActivityClient {
readonly serviceUrl: string;
get http(): Client;
set http(v: Client);
protected _http: Client;
constructor(serviceUrl: string, options?: Client | ClientOptions);
create(conversationId: string, params: ActivityParams): Promise<Resource>;
update(conversationId: string, id: string, params: ActivityParams): Promise<Resource>;
reply(conversationId: string, id: string, params: ActivityParams): Promise<Resource>;
delete(conversationId: string, id: string): Promise<void>;
getMembers(conversationId: string, id: string): Promise<Account[]>;
}
export { type ActivityParams as A, ConversationActivityClient as C, type InvokeActivity as I, type MessagingExtensionAction as M, type SentActivity as S, type ActivityLike as a, type Activity as b, type MessageExtensionInvokeActivity as c, type IMessageExtensionFetchTaskInvokeActivity as d, type IMessageExtensionSubmitActionInvokeActivity as e, toActivityParams as t };