@azure/communication-react 1.17.0 → 1.18.0-alpha-202406080014

package/dist/dist-esm/react-composites/src/composites/CallComposite/adapter/AzureCommunicationCallAdapter.d.ts

@@ -5,6 +5,7 @@ import { TeamsMeetingIdLocator } from '@azure/communication-calling';
 import { Reaction } from '@azure/communication-calling';
 import { StartCaptionsOptions } from '@azure/communication-calling';
 import { TeamsCallAgent } from '@azure/communication-calling';
+import { AddPhoneNumberOptions } from '@azure/communication-calling';
 import { DtmfTone } from '@azure/communication-calling';
 import { CommonCallAdapter, CallEndedListener, CallIdChangedListener, CallAdapterState, DisplayNameChangedListener, IsMutedChangedListener, IsLocalScreenSharingActiveChangedListener, IsSpeakingChangedListener, ParticipantsJoinedListener, ParticipantsLeftListener, DiagnosticChangedEventListner, CallAdapter, JoinCallOptions, StartCallIdentifier } from './CallAdapter';
 import { ReactionResources } from "../../../../../react-components/src";
@@ -15,7 +16,8 @@ import { CaptionsReceivedListener, IsCaptionsActiveChangedListener, IsCaptionLan
 import { VideoBackgroundImage, VideoBackgroundEffect } from './CallAdapter';
 import { TeamsCallAdapter } from './CallAdapter';
 import { CreateVideoStreamViewResult, VideoStreamOptions } from "../../../../../react-components/src";
-import { CommunicationTokenCredential, CommunicationUserIdentifier, MicrosoftTeamsUserIdentifier, MicrosoftTeamsAppIdentifier, UnknownIdentifier } from '@azure/communication-common';
+import { CommunicationTokenCredential, CommunicationUserIdentifier, CommunicationIdentifier, MicrosoftTeamsUserIdentifier, MicrosoftTeamsAppIdentifier, UnknownIdentifier } from '@azure/communication-common';
+import { PhoneNumberIdentifier } from '@azure/communication-common';
 import { AdapterError } from '../../common/adapters';
 import { OnFetchProfileCallback } from './OnFetchProfileCallback';
 import { VideoBackgroundEffectsDependency } from "../../../../../calling-component-bindings/src";
@@ -75,21 +77,27 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     raiseHand(): Promise<void>;
     lowerHand(): Promise<void>;
     onReactionClick(reaction: Reaction): Promise<void>;
+    allowUnsupportedBrowserVersion(): void;
     startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>;
     stopVideoBackgroundEffects(): Promise<void>;
     updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[]): void;
     updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect): void;
-    startCall(participants: string[] | (MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): CallTypeOf<AgentType> | undefined;
+    startCall(participants: string[] | (MicrosoftTeamsAppIdentifier | /* @conditional-compile-remove(PSTN-calls) */ PhoneNumberIdentifier | /* @conditional-compile-remove(one-to-n-calling) */ CommunicationUserIdentifier | /* @conditional-compile-remove(teams-adhoc-call) */ MicrosoftTeamsUserIdentifier | UnknownIdentifier)[], options?: StartCallOptions): CallTypeOf<AgentType> | undefined;
     private processNewCall;
     private isBlurEffect;
     private isReplacementEffect;
-    removeParticipant(userId: string): Promise<void>;
+    removeParticipant(userId: string | /* @conditional-compile-remove(PSTN-calls) */ CommunicationIdentifier): Promise<void>;
+    addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>;
+    addParticipant(participant: CommunicationUserIdentifier): Promise<void>;
+    holdCall(): Promise<void>;
+    resumeCall(): Promise<void>;
     sendDtmfTone(dtmfTone: DtmfTone): Promise<void>;
     startCaptions(options?: StartCaptionsOptions): Promise<void>;
     stopCaptions(): Promise<void>;
     setCaptionLanguage(language: string): Promise<void>;
     setSpokenLanguage(language: string): Promise<void>;
     submitSurvey(survey: CallSurvey): Promise<CallSurveyResponse | undefined>;
+    muteParticipant(userId: string): Promise<void>;
     startSpotlight(userIds?: string[]): Promise<void>;
     stopSpotlight(userIds?: string[]): Promise<void>;
     stopAllSpotlight(): Promise<void>;
@@ -121,9 +129,11 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     private subscribeCallEvents;
     private unsubscribeCallEvents;
     private isMyMutedChanged;
+    private captionsKindChanged;
     private onRemoteParticipantsUpdated;
     private isScreenSharingOnChanged;
     private teamsCaptionsReceived;
+    private captionsReceived;
     private isCaptionsActiveChanged;
     private isSpokenLanguageChanged;
     private isCaptionLanguageChanged;
@@ -156,12 +166,28 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     private asyncTeeErrorToEventEmitter;
     private teeErrorToEventEmitter;
 }
+/**
+ * Locator used by {@link createAzureCommunicationCallAdapter} to call one or more participants
+ *
+ * @remarks
+ * This is currently in beta and only supports calling one Teams User.
+ *
+ * @example
+ * ```
+ * ['8:orgid:ab220efe-5725-4742-9792-9fba7c9ac458']
+ * ```
+ *
+ * @beta
+ */
+export type CallParticipantsLocator = {
+    participantIds: string[];
+};
 /**
  * Locator used by {@link createAzureCommunicationCallAdapter} to locate the call to join
  *
  * @public
  */
-export type CallAdapterLocator = TeamsMeetingLinkLocator | GroupCallLocator | RoomCallLocator | /* @conditional-compile-remove(meeting-id) */ TeamsMeetingIdLocator;
+export type CallAdapterLocator = TeamsMeetingLinkLocator | GroupCallLocator | RoomCallLocator | /* @conditional-compile-remove(teams-adhoc-call) */ /* @conditional-compile-remove(PSTN-calls) */ CallParticipantsLocator | /* @conditional-compile-remove(meeting-id) */ TeamsMeetingIdLocator;
 /**
  * Common optional parameters to create {@link AzureCommunicationCallAdapter} or {@link TeamsCallAdapter}
  *
@@ -209,6 +235,11 @@ export type AzureCommunicationCallAdapterArgs = {
     displayName: string;
     credential: CommunicationTokenCredential;
     locator: CallAdapterLocator;
+    /**
+     * A phone number in E.164 format procured using Azure Communication Services that will be used to represent callers identity.
+     * E.164 numbers are formatted as [+] [country code] [phone number including area code]. For example, +14255550123 for a US phone number.
+     */
+    alternateCallerId?: string;
     /**
      * Optional parameters for the {@link AzureCommunicationCallAdapter} created
      */
@@ -228,6 +259,11 @@ export type AzureCommunicationOutboundCallAdapterArgs = {
     displayName: string;
     credential: CommunicationTokenCredential;
     targetCallees: StartCallIdentifier[];
+    /**
+     * A phone number in E.164 format procured using Azure Communication Services that will be used to represent callers identity.
+     * E.164 numbers are formatted as [+] [country code] [phone number including area code]. For example, +14255550123 for a US phone number.
+     */
+    alternateCallerId?: string;
     /**
      * Optional parameters for the {@link AzureCommunicationCallAdapter} created
      */
@@ -240,19 +276,39 @@ export type AzureCommunicationOutboundCallAdapterArgs = {
  */
 export type TeamsAdapterOptions = CommonCallAdapterOptions;
 /**
- * Arguments for creating the Azure Communication Services implementation of {@link TeamsCallAdapter}.
+ * Common part of args to create the Azure Communication Services implementation of {@link TeamsCallAdapter}.
  *
  * @public
  */
-export type TeamsCallAdapterArgs = {
+export type TeamsCallAdapterArgsCommon = {
     userId: MicrosoftTeamsUserIdentifier;
     credential: CommunicationTokenCredential;
-    locator: TeamsMeetingLinkLocator | /* @conditional-compile-remove(meeting-id) */ TeamsMeetingIdLocator;
-    /**
-     * Optional parameters for the {@link TeamsCallAdapter} created
-     */
     options?: TeamsAdapterOptions;
 };
+/**
+ * Arguments for creating the Azure Communication Services implementation of {@link TeamsCallAdapter}.
+ *
+ * @public
+ */
+export type TeamsCallAdapterArgs = TeamsCallAdapterArgsCommon & {
+    locator: TeamsMeetingLinkLocator | /* @conditional-compile-remove(teams-adhoc-call) */ /* @conditional-compile-remove(PSTN-calls) */ CallParticipantsLocator | /* @conditional-compile-remove(meeting-id) */ TeamsMeetingIdLocator;
+};
+/**
+ * Parameter to start a call using a Teams user identity.
+ *
+ * @beta
+ */
+export type StartTeamsCallIdentifier = MicrosoftTeamsUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier;
+/**
+ * Arguments for creating the Azure Communication Services implementation of {@link TeamsCallAdapter}.
+ *
+ * This is used to create an outbound call scenarios.
+ *
+ * @beta
+ */
+export type TeamsOutboundCallAdapterArgs = TeamsCallAdapterArgsCommon & {
+    targetCallees: StartTeamsCallIdentifier[];
+};
 /**
  * Create a {@link CallAdapter} backed by Azure Communication Services.
  *
@@ -278,19 +334,20 @@ export declare function createAzureCommunicationCallAdapter(args: AzureCommunica
  *
  * @internal
  */
-export declare const _createAzureCommunicationCallAdapterInner: ({ userId, displayName, credential, locator, targetCallees, options, telemetryImplementationHint }: {
+export declare const _createAzureCommunicationCallAdapterInner: ({ userId, displayName, credential, locator, targetCallees, alternateCallerId, options, telemetryImplementationHint }: {
     userId: CommunicationUserIdentifier;
     displayName: string;
     credential: CommunicationTokenCredential;
     locator: CallAdapterLocator;
     targetCallees?: StartCallIdentifier[];
+    alternateCallerId?: string;
     options?: AzureCommunicationCallAdapterOptions;
     telemetryImplementationHint?: _TelemetryImplementationHint;
 }) => Promise<CallAdapter>;
 /**
  * @public
  */
-export declare const createTeamsCallAdapter: (args: TeamsCallAdapterArgs) => Promise<TeamsCallAdapter>;
+export declare const createTeamsCallAdapter: (args: TeamsCallAdapterArgs | /* @conditional-compile-remove(teams-identity-support-beta) */ TeamsOutboundCallAdapterArgs) => Promise<TeamsCallAdapter>;
 /**
  * A custom React hook to simplify the creation of {@link CallAdapter}.
  *
@@ -320,7 +377,7 @@ export declare const useAzureCommunicationCallAdapter: (args: Partial<AzureCommu
  *
  * @public
  */
-export declare const useTeamsCallAdapter: (args: Partial<TeamsCallAdapterArgs>, afterCreate?: (adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>, beforeDispose?: (adapter: TeamsCallAdapter) => Promise<void>) => TeamsCallAdapter | undefined;
+export declare const useTeamsCallAdapter: (args: Partial<TeamsCallAdapterArgs | /* @conditional-compile-remove(teams-identity-support-beta) */ TeamsOutboundCallAdapterArgs>, afterCreate?: (adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>, beforeDispose?: (adapter: TeamsCallAdapter) => Promise<void>) => TeamsCallAdapter | undefined;
 /**
  * Create a {@link CallAdapter} using the provided {@link StatefulCallClient}.
  *
@@ -347,6 +404,6 @@ export declare function createAzureCommunicationCallAdapterFromClient(callClient
  *
  * @public
  */
-export declare const createTeamsCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: TeamsCallAgent, locator: CallAdapterLocator, options?: TeamsAdapterOptions) => Promise<TeamsCallAdapter>;
+export declare const createTeamsCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: TeamsCallAgent, locator: CallAdapterLocator | /* @conditional-compile-remove(teams-identity-support-beta) */ StartTeamsCallIdentifier[], options?: TeamsAdapterOptions) => Promise<TeamsCallAdapter>;
 export {};
 //# sourceMappingURL=AzureCommunicationCallAdapter.d.ts.map