UNPKG

@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

54 lines (51 loc) • 2.44 kB
import { Client, ClientOptions } from '@microsoft/teams.common'; import { ApiClientSettings } from './api-client-settings.mjs'; import { MeetingInfo } from '../models/meeting/meeting-info.mjs'; import { MeetingNotificationParams, MeetingNotificationResponse } from '../models/meeting/meeting-notification.mjs'; import { MeetingParticipant } from '../models/meeting/meeting-participant.mjs'; import '../auth/cloud-environment.mjs'; import '../auth/credentials.mjs'; import '../models/agentic-identity.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/meeting/meeting-details.mjs'; import '../models/meeting/meeting.mjs'; declare class MeetingClient { readonly serviceUrl: string; get http(): Client; set http(v: Client); protected _http: Client; protected _apiClientSettings: Partial<ApiClientSettings>; constructor(serviceUrl: string, options?: Client | ClientOptions, apiClientSettings?: Partial<ApiClientSettings>); /** * Retrieves meeting information including details, organizer, and conversation. * @param id - The meeting ID. */ getById(id: string): Promise<MeetingInfo>; /** * Retrieves information about a specific participant in a meeting. * @param meetingId - The meeting ID. * @param id - The user AAD object ID * @param tenantId - The tenant ID of the meeting and user. * @returns {MeetingParticipant} The meeting participant information. */ getParticipant(meetingId: string, id: string, tenantId: string): Promise<MeetingParticipant>; /** * Send a targeted in-meeting notification to specific participants. * * Returns `undefined` on full success (HTTP 202). Returns a `MeetingNotificationResponse` * with per-recipient failure info on partial success (HTTP 207). * * Requires the RSC permission `OnlineMeetingNotification.Send.Chat` and the ECS flag * enabled for the tenant/bot. * * @param meetingId - The BASE64-encoded meeting ID. * @param params - The notification parameters including recipients and surfaces. */ sendNotification(meetingId: string, params: MeetingNotificationParams): Promise<MeetingNotificationResponse | undefined>; } export { MeetingClient };