@azure/communication-react 1.7.0-beta.2 → 1.7.0

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

@@ -1,17 +1,8 @@
 import { StatefulCallClient, StatefulDeviceManager, TeamsCall, TeamsCallAgent as BetaTeamsCallAgent } from "../../../../../calling-stateful-client/src";
 import { CallAgent, GroupCallLocator, TeamsMeetingLinkLocator, AudioDeviceInfo, VideoDeviceInfo, PermissionConstraints, PropertyChangedEvent, StartCallOptions, Call } from '@azure/communication-calling';
-import { StartCaptionsOptions } 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 } from './CallAdapter';
-import { TransferRequestedListener } from './CallAdapter';
-import { CaptionsReceivedListener, IsCaptionsActiveChangedListener } from './CallAdapter';
-import { VideoBackgroundImage, VideoBackgroundEffect } from './CallAdapter';
-import { TeamsCallAdapter } from './CallAdapter';
+import { CommonCallAdapter, CallEndedListener, CallIdChangedListener, CallAdapterState, DisplayNameChangedListener, IsMutedChangedListener, IsLocalScreenSharingActiveChangedListener, IsSpeakingChangedListener, ParticipantsJoinedListener, ParticipantsLeftListener, DiagnosticChangedEventListner, CallAdapter, JoinCallOptions } from './CallAdapter';
 import { CreateVideoStreamViewResult, VideoStreamOptions } from "../../../../../react-components/src";
-import { Role } from "../../../../../react-components/src";
-import { CommunicationTokenCredential, CommunicationUserIdentifier, PhoneNumberIdentifier, CommunicationIdentifier, MicrosoftTeamsUserIdentifier } from '@azure/communication-common';
+import { CommunicationTokenCredential, CommunicationUserIdentifier, CommunicationIdentifier, MicrosoftTeamsUserIdentifier } from '@azure/communication-common';
 import { AdapterError } from '../../common/adapters';
 import { OnFetchProfileCallback } from './OnFetchProfileCallback';
 declare type CallTypeOf<AgentType extends CallAgent | BetaTeamsCallAgent> = AgentType extends CallAgent ? Call : TeamsCall;
@@ -37,7 +28,7 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     private onClientStateChange;
     private get call();
     private set call(value);
-    constructor(callClient: StatefulCallClient, locator: CallAdapterLocator, callAgent: AgentType, deviceManager: StatefulDeviceManager, options?: AzureCommunicationCallAdapterOptions & TeamsAdapterOptions);
+    constructor(callClient: StatefulCallClient, locator: CallAdapterLocator, callAgent: AgentType, deviceManager: StatefulDeviceManager, options?: AzureCommunicationCallAdapterOptions | TeamsAdapterOptions);
     private subscribeDeviceManagerEvents;
     private bindPublicMethods;
     dispose(): void;
@@ -45,7 +36,7 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     queryMicrophones(): Promise<AudioDeviceInfo[]>;
     querySpeakers(): Promise<AudioDeviceInfo[]>;
     askDevicePermission(constrain: PermissionConstraints): Promise<void>;
-    joinCall(microphoneOn?: boolean): CallTypeOf<AgentType> | undefined;
+    joinCall(options?: boolean | JoinCallOptions): CallTypeOf<AgentType> | undefined;
     private _joinCall;
     createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>;
     disposeStreamView(remoteUserId?: string): Promise<void>;
@@ -62,25 +53,9 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     unmute(): Promise<void>;
     startScreenShare(): Promise<void>;
     stopScreenShare(): 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;
     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>;
-    sendDtmfTone(dtmfTone: DtmfTone): Promise<void>;
-    startCaptions(options?: StartCaptionsOptions): Promise<void>;
-    stopCaptions(): Promise<void>;
-    setCaptionLanguage(language: string): Promise<void>;
-    setSpokenLanguage(language: string): Promise<void>;
+    removeParticipant(userId: string): Promise<void>;
     getState(): CallAdapterState;
     onStateChange(handler: (state: CallAdapterState) => void): void;
     offStateChange(handler: (state: CallAdapterState) => void): void;
@@ -96,19 +71,11 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     on(event: 'selectedMicrophoneChanged', listener: PropertyChangedEvent): void;
     on(event: 'selectedSpeakerChanged', listener: PropertyChangedEvent): void;
     on(event: 'error', errorHandler: (e: AdapterError) => void): void;
-    on(event: 'captionsReceived', listener: CaptionsReceivedListener): void;
-    on(event: 'isCaptionsActiveChanged', listener: IsCaptionsActiveChangedListener): void;
-    on(event: 'transferRequested', listener: TransferRequestedListener): void;
-    private subscribeToCaptionEvents;
-    private unsubscribeFromCaptionEvents;
     private subscribeCallEvents;
     private unsubscribeCallEvents;
     private isMyMutedChanged;
     private onRemoteParticipantsUpdated;
     private isScreenSharingOnChanged;
-    private captionsReceived;
-    private isCaptionsActiveChanged;
-    private transferRequested;
     private callIdChanged;
     private resetDiagnosticsForwarder;
     off(event: 'participantsJoined', listener: ParticipantsJoinedListener): void;
@@ -123,44 +90,21 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     off(event: 'selectedMicrophoneChanged', listener: PropertyChangedEvent): void;
     off(event: 'selectedSpeakerChanged', listener: PropertyChangedEvent): void;
     off(event: 'error', errorHandler: (e: AdapterError) => void): void;
-    off(event: 'captionsReceived', listener: CaptionsReceivedListener): void;
-    off(event: 'isCaptionsActiveChanged', listener: IsCaptionsActiveChangedListener): void;
-    off(event: 'transferRequested', listener: TransferRequestedListener): 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 declare type CallParticipantsLocator = {
-    participantIds: string[];
-};
 /**
  * Locator used by {@link createAzureCommunicationCallAdapter} to locate the call to join
  *
  * @public
  */
-export declare type CallAdapterLocator = TeamsMeetingLinkLocator | GroupCallLocator | /* @conditional-compile-remove(rooms) */ RoomCallLocator | /* @conditional-compile-remove(teams-adhoc-call) */ /* @conditional-compile-remove(PSTN-calls) */ CallParticipantsLocator;
+export declare type CallAdapterLocator = TeamsMeetingLinkLocator | GroupCallLocator;
 /**
  * Common optional parameters to create {@link AzureCommunicationCallAdapter} or {@link TeamsCallAdapter}
  *
  * @beta
  */
 export declare type CommonCallAdapterOptions = {
-    /**
-     * Default set of background images for background image picker.
-     */
-    videoBackgroundImages?: VideoBackgroundImage[];
     /**
      * 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
@@ -173,14 +117,7 @@ export declare type CommonCallAdapterOptions = {
  *
  * @beta
  */
-export declare type AzureCommunicationCallAdapterOptions = {
-    /**
-     * Use this to hint the role of the user when the role is not available before a Rooms call is started. This value
-     * should be obtained using the Rooms API. This role will determine permissions in the configuration page of the
-     * {@link CallComposite}. The true role of the user will be synced with ACS services when a Rooms call starts.
-     */
-    roleHint?: Role;
-} & CommonCallAdapterOptions;
+export declare type AzureCommunicationCallAdapterOptions = CommonCallAdapterOptions;
 /**
  * Arguments for creating the Azure Communication Services implementation of {@link CallAdapter}.
  *
@@ -193,15 +130,6 @@ export declare 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
-     */
-    options?: AzureCommunicationCallAdapterOptions;
 };
 /**
  * Optional parameters to create {@link TeamsCallAdapter}
@@ -217,7 +145,7 @@ export declare type TeamsAdapterOptions = CommonCallAdapterOptions;
 export declare 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
      */
@@ -232,11 +160,7 @@ export declare type TeamsCallAdapterArgs = {
  *
  * @public
  */
-export declare const createAzureCommunicationCallAdapter: ({ userId, displayName, credential, locator, alternateCallerId, options }: AzureCommunicationCallAdapterArgs) => Promise<CallAdapter>;
-/**
- * @beta
- */
-export declare const createTeamsCallAdapter: ({ userId, credential, locator, options }: TeamsCallAdapterArgs) => Promise<TeamsCallAdapter>;
+export declare const createAzureCommunicationCallAdapter: ({ userId, displayName, credential, locator }: AzureCommunicationCallAdapterArgs) => Promise<CallAdapter>;
 /**
  * A custom React hook to simplify the creation of {@link CallAdapter}.
  *
@@ -252,21 +176,6 @@ 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;
 /**
  * Create a {@link CallAdapter} using the provided {@link StatefulCallClient}.
  *
@@ -275,15 +184,6 @@ export declare const useTeamsCallAdapter: (args: Partial<TeamsCallAdapterArgs>,
  *
  * @public
  */
-export declare const createAzureCommunicationCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator, /* @conditional-compile-remove(rooms) */ /* @conditional-compile-remove(video-background-effects) */ options?: AzureCommunicationCallAdapterOptions) => Promise<CallAdapter>;
-/**
- * Create a {@link TeamsCallAdapter} 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
- */
-export declare const createTeamsCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: TeamsCallAgent, locator: CallAdapterLocator, options?: CommonCallAdapterOptions | undefined) => Promise<TeamsCallAdapter>;
+export declare const createAzureCommunicationCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator) => Promise<CallAdapter>;
 export {};
 //# sourceMappingURL=AzureCommunicationCallAdapter.d.ts.map