@azure/communication-react 1.13.0-beta.1 → 1.13.0

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

@@ -2,21 +2,16 @@ import { StatefulCallClient, StatefulDeviceManager, TeamsCall, TeamsCallAgent as
 import { _TelemetryImplementationHint } from "../../../../../acs-ui-common/src";
 import { CallAgent, GroupCallLocator, TeamsMeetingLinkLocator, AudioDeviceInfo, VideoDeviceInfo, PermissionConstraints, PropertyChangedEvent, StartCallOptions, Call } from '@azure/communication-calling';
 import { StartCaptionsOptions } from '@azure/communication-calling';
-import type { CapabilitiesChangeHandler } from '@azure/communication-calling';
-import { TeamsCallAgent } from '@azure/communication-calling';
 import { RoomCallLocator } from '@azure/communication-calling';
-import { AddPhoneNumberOptions, DtmfTone } from '@azure/communication-calling';
-import { CommonCallAdapter, CallEndedListener, CallIdChangedListener, CallAdapterState, DisplayNameChangedListener, IsMutedChangedListener, IsLocalScreenSharingActiveChangedListener, IsSpeakingChangedListener, ParticipantsJoinedListener, ParticipantsLeftListener, DiagnosticChangedEventListner, CallAdapter, JoinCallOptions } from './CallAdapter';
-import { TransferRequestedListener } from './CallAdapter';
+import { DtmfTone } from '@azure/communication-calling';
+import { CommonCallAdapter, CallEndedListener, CallIdChangedListener, CallAdapterState, DisplayNameChangedListener, IsMutedChangedListener, IsLocalScreenSharingActiveChangedListener, IsSpeakingChangedListener, ParticipantsJoinedListener, ParticipantsLeftListener, DiagnosticChangedEventListner, CallAdapter, JoinCallOptions, StartCallIdentifier } from './CallAdapter';
+import { TransferAcceptedListener } from './CallAdapter';
 import { CapabilitiesChangedListener } from './CallAdapter';
 import { CaptionsReceivedListener, IsCaptionsActiveChangedListener, IsCaptionLanguageChangedListener, IsSpokenLanguageChangedListener } from './CallAdapter';
 import { VideoBackgroundImage, VideoBackgroundEffect } from './CallAdapter';
-import { TeamsCallAdapter } from './CallAdapter';
 import { CreateVideoStreamViewResult, VideoStreamOptions } from "../../../../../react-components/src";
-import { CommunicationTokenCredential, CommunicationUserIdentifier, CommunicationIdentifier, MicrosoftTeamsUserIdentifier } from '@azure/communication-common';
-import { PhoneNumberIdentifier } from '@azure/communication-common';
+import { CommunicationTokenCredential, CommunicationUserIdentifier, MicrosoftTeamsUserIdentifier, MicrosoftTeamsAppIdentifier, UnknownIdentifier } from '@azure/communication-common';
 import { AdapterError } from '../../common/adapters';
-import { OnFetchProfileCallback } from './OnFetchProfileCallback';
 import { VideoBackgroundEffectsDependency } from "../../../../../calling-component-bindings/src";
 import { CallingSounds } from './CallAdapter';
 type CallTypeOf<AgentType extends CallAgent | BetaTeamsCallAgent> = AgentType extends CallAgent ? Call : TeamsCall;
@@ -31,7 +26,8 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     private callClient;
     private callAgent;
     private deviceManager;
-    private locator;
+    private locator?;
+    targetCallees?: StartCallIdentifier[];
     private _call?;
     private context;
     private diagnosticsForwarder?;
@@ -44,6 +40,7 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     private get call();
     private set call(value);
     constructor(callClient: StatefulCallClient, locator: CallAdapterLocator, callAgent: AgentType, deviceManager: StatefulDeviceManager, options?: AzureCommunicationCallAdapterOptions | TeamsAdapterOptions);
+    constructor(callClient: StatefulCallClient, targetCallees: StartCallIdentifier[], callAgent: AgentType, deviceManager: StatefulDeviceManager, options?: AzureCommunicationCallAdapterOptions | TeamsAdapterOptions);
     private subscribeDeviceManagerEvents;
     private bindPublicMethods;
     dispose(): void;
@@ -70,20 +67,15 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     stopScreenShare(): Promise<void>;
     raiseHand(): Promise<void>;
     lowerHand(): Promise<void>;
-    allowUnsupportedBrowserVersion(): void;
     startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>;
     stopVideoBackgroundEffects(): Promise<void>;
     updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[]): void;
     updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect): void;
-    startCall(participants: string[] | CommunicationIdentifier[], options?: StartCallOptions): CallTypeOf<AgentType> | undefined;
+    startCall(participants: string[] | (MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): CallTypeOf<AgentType> | undefined;
     private processNewCall;
     private isBlurEffect;
     private isReplacementEffect;
-    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>;
+    removeParticipant(userId: string): Promise<void>;
     sendDtmfTone(dtmfTone: DtmfTone): Promise<void>;
     startCaptions(options?: StartCaptionsOptions): Promise<void>;
     stopCaptions(): Promise<void>;
@@ -108,8 +100,8 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     on(event: 'isCaptionsActiveChanged', listener: IsCaptionsActiveChangedListener): void;
     on(event: 'isCaptionLanguageChanged', listener: IsCaptionLanguageChangedListener): void;
     on(event: 'isSpokenLanguageChanged', listener: IsSpokenLanguageChangedListener): void;
-    on(event: 'transferRequested', listener: TransferRequestedListener): void;
-    on(event: 'capabilitiesChanged', listener: CapabilitiesChangeHandler): void;
+    on(event: 'transferAccepted', listener: TransferAcceptedListener): void;
+    on(event: 'capabilitiesChanged', listener: CapabilitiesChangedListener): void;
     on(event: 'roleChanged', listener: PropertyChangedEvent): void;
     private subscribeToCaptionEvents;
     private unsubscribeFromCaptionEvents;
@@ -122,7 +114,7 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     private isCaptionsActiveChanged;
     private isSpokenLanguageChanged;
     private isCaptionLanguageChanged;
-    private transferRequested;
+    private transferAccepted;
     private capabilitiesChanged;
     private roleChanged;
     private callIdChanged;
@@ -143,34 +135,18 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     off(event: 'isCaptionsActiveChanged', listener: IsCaptionsActiveChangedListener): void;
     off(event: 'isCaptionLanguageChanged', listener: IsCaptionLanguageChangedListener): void;
     off(event: 'isSpokenLanguageChanged', listener: IsSpokenLanguageChangedListener): void;
-    off(event: 'transferRequested', listener: TransferRequestedListener): void;
+    off(event: 'transferAccepted', listener: TransferAcceptedListener): void;
     off(event: 'capabilitiesChanged', listener: CapabilitiesChangedListener): void;
     off(event: 'roleChanged', listener: PropertyChangedEvent): void;
     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 | /* @conditional-compile-remove(rooms) */ RoomCallLocator | /* @conditional-compile-remove(teams-adhoc-call) */ /* @conditional-compile-remove(PSTN-calls) */ CallParticipantsLocator;
+export type CallAdapterLocator = TeamsMeetingLinkLocator | GroupCallLocator | /* @conditional-compile-remove(rooms) */ RoomCallLocator;
 /**
  * Common optional parameters to create {@link AzureCommunicationCallAdapter} or {@link TeamsCallAdapter}
  *
@@ -184,12 +160,6 @@ export type CommonCallAdapterOptions = {
         videoBackgroundImages?: VideoBackgroundImage[];
         onResolveDependency?: () => Promise<VideoBackgroundEffectsDependency>;
     };
-    /**
-     * Use this to fetch profile information which will override data in {@link CallAdapterState} like display name
-     * The onFetchProfile is fetch-and-forget one time action for each user, once a user profile is updated, the value will be cached
-     * and would not be updated again within the lifecycle of adapter.
-     */
-    onFetchProfile?: OnFetchProfileCallback;
     /**
      * Sounds to use for calling events
      */
@@ -214,10 +184,24 @@ export type AzureCommunicationCallAdapterArgs = {
     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.
+     * Optional parameters for the {@link AzureCommunicationCallAdapter} created
      */
-    alternateCallerId?: string;
+    options?: AzureCommunicationCallAdapterOptions;
+};
+/**
+ * Arguments for creating the Azure Communication Services implementation of {@link CallAdapter}.
+ *
+ * These arguments are used to create an outbound call scenarios.
+ *
+ * Note: `displayName` can be a maximum of 256 characters.
+ *
+ * @public
+ */
+export type AzureCommunicationOutboundCallAdapterArgs = {
+    userId: CommunicationUserIdentifier;
+    displayName: string;
+    credential: CommunicationTokenCredential;
+    targetCallees: StartCallIdentifier[];
     /**
      * Optional parameters for the {@link AzureCommunicationCallAdapter} created
      */
@@ -237,7 +221,7 @@ export type TeamsAdapterOptions = CommonCallAdapterOptions;
 export type TeamsCallAdapterArgs = {
     userId: MicrosoftTeamsUserIdentifier;
     credential: CommunicationTokenCredential;
-    locator: TeamsMeetingLinkLocator | /* @conditional-compile-remove(teams-adhoc-call) */ /* @conditional-compile-remove(PSTN-calls) */ CallParticipantsLocator;
+    locator: TeamsMeetingLinkLocator;
     /**
      * Optional parameters for the {@link TeamsCallAdapter} created
      */
@@ -252,25 +236,31 @@ export type TeamsCallAdapterArgs = {
  *
  * @public
  */
-export declare const createAzureCommunicationCallAdapter: ({ userId, displayName, credential, locator, alternateCallerId, options }: AzureCommunicationCallAdapterArgs) => Promise<CallAdapter>;
+export declare function createAzureCommunicationCallAdapter(args: AzureCommunicationCallAdapterArgs): Promise<CallAdapter>;
+/**
+ * Create a {@link CallAdapter} backed by Azure Communication Services.
+ *
+ * This is the default implementation of {@link CallAdapter} provided by this library.
+ *
+ * Note: `displayName` can be a maximum of 256 characters.
+ *
+ * @public
+ */
+export declare function createAzureCommunicationCallAdapter(args: AzureCommunicationOutboundCallAdapterArgs): Promise<CallAdapter>;
 /**
  * This inner function is used to allow injection of TelemetryImplementationHint without changing the public API.
  *
  * @internal
  */
-export declare const _createAzureCommunicationCallAdapterInner: ({ userId, displayName, credential, locator, alternateCallerId, options, telemetryImplementationHint }: {
+export declare const _createAzureCommunicationCallAdapterInner: ({ userId, displayName, credential, locator, targetCallees, options, telemetryImplementationHint }: {
     userId: CommunicationUserIdentifier;
     displayName: string;
     credential: CommunicationTokenCredential;
     locator: CallAdapterLocator;
-    alternateCallerId?: string | undefined;
+    targetCallees?: StartCallIdentifier[] | undefined;
     options?: CommonCallAdapterOptions | undefined;
     telemetryImplementationHint?: _TelemetryImplementationHint | undefined;
 }) => Promise<CallAdapter>;
-/**
- * @beta
- */
-export declare const createTeamsCallAdapter: ({ userId, credential, locator, options }: TeamsCallAdapterArgs) => Promise<TeamsCallAdapter>;
 /**
  * A custom React hook to simplify the creation of {@link CallAdapter}.
  *
@@ -285,22 +275,7 @@ export declare const createTeamsCallAdapter: ({ userId, credential, locator, opt
  *
  * @public
  */
-export declare const useAzureCommunicationCallAdapter: (args: Partial<AzureCommunicationCallAdapterArgs>, afterCreate?: ((adapter: CallAdapter) => Promise<CallAdapter>) | undefined, beforeDispose?: ((adapter: CallAdapter) => Promise<void>) | undefined) => CallAdapter | undefined;
-/**
- * A custom React hook to simplify the creation of {@link TeamsCallAdapter}.
- *
- * Similar to {@link createTeamsAzureCommunicationCallAdapter}, but takes care of asynchronous
- * creation of the adapter internally.
- *
- * Allows arguments to be undefined so that you can respect the rule-of-hooks and pass in arguments
- * as they are created. The adapter is only created when all arguments are defined.
- *
- * Note that you must memoize the arguments to avoid recreating adapter on each render.
- * See storybook for typical usage examples.
- *
- * @beta
- */
-export declare const useTeamsCallAdapter: (args: Partial<TeamsCallAdapterArgs>, afterCreate?: ((adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>) | undefined, beforeDispose?: ((adapter: TeamsCallAdapter) => Promise<void>) | undefined) => TeamsCallAdapter | undefined;
+export declare const useAzureCommunicationCallAdapter: (args: Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, afterCreate?: ((adapter: CallAdapter) => Promise<CallAdapter>) | undefined, beforeDispose?: ((adapter: CallAdapter) => Promise<void>) | undefined) => CallAdapter | undefined;
 /**
  * Create a {@link CallAdapter} using the provided {@link StatefulCallClient}.
  *
@@ -309,15 +284,15 @@ export declare const useTeamsCallAdapter: (args: Partial<TeamsCallAdapterArgs>,
  *
  * @public
  */
-export declare const createAzureCommunicationCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator, /* @conditional-compile-remove(video-background-effects) */ options?: AzureCommunicationCallAdapterOptions) => Promise<CallAdapter>;
+export declare function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, targetCallees: StartCallIdentifier[], /* @conditional-compile-remove(video-background-effects) */ options?: AzureCommunicationCallAdapterOptions): Promise<CallAdapter>;
 /**
- * Create a {@link TeamsCallAdapter} using the provided {@link StatefulCallClient}.
+ * Create a {@link CallAdapter} using the provided {@link StatefulCallClient}.
  *
  * Useful if you want to keep a reference to {@link StatefulCallClient}.
  * Consider using {@link createAzureCommunicationCallAdapter} for a simpler API.
  *
- * @beta
+ * @public
  */
-export declare const createTeamsCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: TeamsCallAgent, locator: CallAdapterLocator, options?: TeamsAdapterOptions) => Promise<TeamsCallAdapter>;
+export declare function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator, /* @conditional-compile-remove(video-background-effects) */ options?: AzureCommunicationCallAdapterOptions): Promise<CallAdapter>;
 export {};
 //# sourceMappingURL=AzureCommunicationCallAdapter.d.ts.map