@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
151 lines (148 loc) • 6.97 kB
text/typescript
import { Client as Client$1, ClientOptions } from '@microsoft/teams.common';
import { CloudEnvironment } from '../auth/cloud-environment.mjs';
import { ITokenProvider } from '../auth/credentials.mjs';
import { AgenticIdentity } from '../models/agentic-identity.mjs';
import { ApiClientSettings } from './api-client-settings.mjs';
export { DEFAULT_API_CLIENT_SETTINGS, mergeApiClientSettings } from './api-client-settings.mjs';
import { BotClient } from './bot/index.mjs';
import { ConversationClient } from './conversation/index.mjs';
export { CreateConversationParams, GetConversationsParams, GetConversationsResponse, IConversationActivityOperations } from './conversation/index.mjs';
import { MeetingClient } from './meeting.mjs';
import { ReactionClient } from './reaction/reaction.mjs';
import { TeamClient } from './team.mjs';
import { UserClient } from './user/index.mjs';
export { a as ActivityParams, C as ConversationActivityClient } from '../activity--_UgQSMq.mjs';
export { BOT_SIGNIN_ENDPOINTS, BotSignInClient, GetBotSignInResourceParams, GetBotSignInUrlParams } from './bot/sign-in.mjs';
export { ConversationMemberClient } from './conversation/member.mjs';
export { ExchangeUserTokenParams, GetUserAADTokenParams, GetUserTokenParams, GetUserTokenStatusParams, SignOutUserParams, USER_TOKEN_ENDPOINTS, UserTokenClient } from './user/token.mjs';
import '../models/sign-in/sign-in-url-response.mjs';
import '../models/token/token-post-resource.mjs';
import '../models/token-exchange/token-exchange-resource.mjs';
import '../models/conversation/conversation.mjs';
import '../models/account.mjs';
import '../models/conversation-type.mjs';
import '../models/membership-source.mjs';
import '../models/membership-source-types.mjs';
import '../models/membership-types.mjs';
import '../models/role.mjs';
import '../models/conversation/conversation-resource.mjs';
import '../models/conversation/paged-members-result.mjs';
import '../models/message/message-reaction.mjs';
import '../models/message/message-user.mjs';
import '../models/resource.mjs';
import '@microsoft/teams.cards';
import '../message-BhoTpQct.mjs';
import '../models/entity/mention-entity.mjs';
import '../models/entity/quoted-reply-entity.mjs';
import '../models/input-hint.mjs';
import '../models/text-format.mjs';
import '../models/attachment/attachment.mjs';
import '../models/attachment/card-attachment.mjs';
import '../models/card/animation-card.mjs';
import '../models/card/card-action.mjs';
import '../models/card/media-url.mjs';
import '../models/card/thumbnail-url.mjs';
import '../models/card/audio-card.mjs';
import '../models/card/hero-card.mjs';
import '../models/card/card-image.mjs';
import '../models/card/thumbnail-card.mjs';
import '../models/card/video-card.mjs';
import '../models/oauth/oauth-card.mjs';
import '../models/sign-in/sign-in-card.mjs';
import '../models/attachment/attachment-layout.mjs';
import '../models/suggested-actions.mjs';
import '../models/importance.mjs';
import '../models/delivery-mode.mjs';
import '../activities/activity.mjs';
import '../models/channel-id.mjs';
import '../models/conversation/conversation-reference.mjs';
import '../models/entity/index.mjs';
import '../models/entity/ai-message-entity.mjs';
import '../models/entity/message-entity.mjs';
import '../models/entity/citation-entity.mjs';
import '../models/entity/sensitivity-usage-info.mjs';
import '../models/entity/client-info-entity.mjs';
import '../models/entity/product-info-entity.mjs';
import '../models/entity/sensitive-usage-entity.mjs';
import '../models/entity/stream-info-entity.mjs';
import '../models/entity/targeted-message-info-entity.mjs';
import '../models/channel-data/index.mjs';
import '../models/meeting/meeting-info.mjs';
import '../models/meeting/meeting-details.mjs';
import '../models/channel-data/app-info.mjs';
import '../models/channel-data/channel-info.mjs';
import '../models/channel-data/chat-info.mjs';
import '../models/channel-data/feedback-loop.mjs';
import '../models/channel-data/notification-info.mjs';
import '../models/channel-data/on-behalf-of.mjs';
import '../models/channel-data/reply-chain-info.mjs';
import '../models/channel-data/settings.mjs';
import '../models/channel-data/source-info.mjs';
import '../models/channel-data/team-info.mjs';
import '../models/channel-data/tenant-info.mjs';
import '../activities/typing.mjs';
import '../activities/message/message-update.mjs';
import '../models/meeting/meeting-notification.mjs';
import '../models/meeting/meeting-participant.mjs';
import '../models/meeting/meeting.mjs';
import '../models/team-details.mjs';
import '../models/token/token-response.mjs';
import '../models/token/token-status.mjs';
import '../models/token-exchange/token-exchange-request.mjs';
/**
* Options for creating a scoped API client from an existing client.
*/
type ApiClientCloneOptions = Omit<Partial<ApiClientSettings>, 'agenticIdentity'> & {
/**
* Service URL for the scoped client. Defaults to the current client's service URL.
*/
readonly serviceUrl?: string;
/**
* `undefined` preserves the current client default; `null` clears it.
*/
readonly agenticIdentity?: AgenticIdentity | null;
};
/**
* Options for creating a scoped API client for a specific Bot Framework service URL.
*/
type ApiClientFromServiceUrlOptions = {
/**
* Service URL for the scoped client.
*/
readonly serviceUrl: string;
};
declare class Client {
readonly serviceUrl: string;
readonly bots: BotClient;
readonly users: UserClient;
readonly conversations: ConversationClient;
readonly teams: TeamClient;
readonly meetings: MeetingClient;
readonly reactions: ReactionClient;
get http(): Client$1;
set http(v: Client$1);
protected _http: Client$1;
protected _baseHttp: Client$1;
protected _apiClientSettings: Partial<ApiClientSettings>;
protected _tokenProvider?: ITokenProvider;
protected _cloud?: CloudEnvironment;
protected _defaultAgenticIdentity?: AgenticIdentity;
constructor(serviceUrl: string, httpOptions?: Client$1 | ClientOptions, apiClientSettings?: Partial<ApiClientSettings>);
/**
* Create a scoped API client that reuses this client's HTTP configuration and token provider.
*/
clone(options?: ApiClientCloneOptions): Client;
/**
* Create a scoped API client for the provided agentic identity.
*
* @param agenticIdentity Agentic operation identity used by the scoped client
* when acquiring auth tokens.
*/
forAgenticIdentity(agenticIdentity: AgenticIdentity): Client;
/**
* Create a scoped API client for the provided Bot Framework service URL.
*/
fromServiceUrl(options: ApiClientFromServiceUrlOptions): Client;
private prepareHttpClient;
}
export { type ApiClientCloneOptions, type ApiClientFromServiceUrlOptions, ApiClientSettings, BotClient, Client, ConversationClient, MeetingClient, ReactionClient, TeamClient, UserClient };