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

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

@@ -1,27 +1,22 @@
 import { StatefulCallClient, StatefulDeviceManager, TeamsCall, TeamsCallAgent as BetaTeamsCallAgent } from "../../../../../calling-stateful-client/src";
+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 { 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 { AdapterError } from '../../common/adapters';
-import { OnFetchProfileCallback } from './OnFetchProfileCallback';
 import { VideoBackgroundEffectsDependency } from "../../../../../calling-component-bindings/src";
-declare type CallTypeOf<AgentType extends CallAgent | BetaTeamsCallAgent> = AgentType extends CallAgent ? Call : TeamsCall;
+type CallTypeOf<AgentType extends CallAgent | BetaTeamsCallAgent> = AgentType extends CallAgent ? Call : TeamsCall;
 /**
  * @private
  */
-export declare type AdapterStateModifier = (state: CallAdapterState) => CallAdapterState;
+export type AdapterStateModifier = (state: CallAdapterState) => CallAdapterState;
 /**
  * @private
  */
@@ -67,7 +62,6 @@ 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;
@@ -76,12 +70,7 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     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>;
+    removeParticipant(userId: string): Promise<void>;
     startCaptions(options?: StartCaptionsOptions): Promise<void>;
     stopCaptions(): Promise<void>;
     setCaptionLanguage(language: string): Promise<void>;
@@ -105,8 +94,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: 'roleChanged', listener: PropertyChangedEvent): void;
     private subscribeToCaptionEvents;
     private unsubscribeFromCaptionEvents;
     private subscribeCallEvents;
@@ -118,8 +107,8 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     private isCaptionsActiveChanged;
     private isSpokenLanguageChanged;
     private isCaptionLanguageChanged;
-    private transferRequested;
     private capabilitiesChanged;
+    private roleChanged;
     private callIdChanged;
     private resetDiagnosticsForwarder;
     off(event: 'participantsJoined', listener: ParticipantsJoinedListener): void;
@@ -138,39 +127,23 @@ 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: '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 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 type CallAdapterLocator = TeamsMeetingLinkLocator | GroupCallLocator | /* @conditional-compile-remove(rooms) */ RoomCallLocator;
 /**
  * Common optional parameters to create {@link AzureCommunicationCallAdapter} or {@link TeamsCallAdapter}
  *
  * @public
  */
-export declare type CommonCallAdapterOptions = {
+export type CommonCallAdapterOptions = {
     /**
      * Default set of background images for background image picker.
      */
@@ -178,19 +151,13 @@ export declare 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;
 };
 /**
  * Optional parameters to create {@link AzureCommunicationCallAdapter}
  *
  * @public
  */
-export declare type AzureCommunicationCallAdapterOptions = CommonCallAdapterOptions;
+export type AzureCommunicationCallAdapterOptions = CommonCallAdapterOptions;
 /**
  * Arguments for creating the Azure Communication Services implementation of {@link CallAdapter}.
  *
@@ -198,16 +165,11 @@ export declare type AzureCommunicationCallAdapterOptions = CommonCallAdapterOpti
  *
  * @public
  */
-export declare type AzureCommunicationCallAdapterArgs = {
+export type AzureCommunicationCallAdapterArgs = {
     userId: CommunicationUserIdentifier;
     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
      */
@@ -218,16 +180,16 @@ export declare type AzureCommunicationCallAdapterArgs = {
  *
  * @public
  */
-export declare type TeamsAdapterOptions = CommonCallAdapterOptions;
+export type TeamsAdapterOptions = CommonCallAdapterOptions;
 /**
  * Arguments for creating the Azure Communication Services implementation of {@link TeamsCallAdapter}.
  *
  * @beta
  */
-export declare type TeamsCallAdapterArgs = {
+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
      */
@@ -242,11 +204,20 @@ export declare type TeamsCallAdapterArgs = {
  *
  * @public
  */
-export declare const createAzureCommunicationCallAdapter: ({ userId, displayName, credential, locator, alternateCallerId, options }: AzureCommunicationCallAdapterArgs) => Promise<CallAdapter>;
+export declare const createAzureCommunicationCallAdapter: ({ userId, displayName, credential, locator, options }: AzureCommunicationCallAdapterArgs) => Promise<CallAdapter>;
 /**
- * @beta
+ * This inner function is used to allow injection of TelemetryImplementationHint without changing the public API.
+ *
+ * @internal
  */
-export declare const createTeamsCallAdapter: ({ userId, credential, locator, options }: TeamsCallAdapterArgs) => Promise<TeamsCallAdapter>;
+export declare const _createAzureCommunicationCallAdapterInner: ({ userId, displayName, credential, locator, options, telemetryImplementationHint }: {
+    userId: CommunicationUserIdentifier;
+    displayName: string;
+    credential: CommunicationTokenCredential;
+    locator: CallAdapterLocator;
+    options?: CommonCallAdapterOptions | undefined;
+    telemetryImplementationHint?: _TelemetryImplementationHint | undefined;
+}) => Promise<CallAdapter>;
 /**
  * A custom React hook to simplify the creation of {@link CallAdapter}.
  *
@@ -262,21 +233,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}.
  *
@@ -286,14 +242,5 @@ 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>;
-/**
- * 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 {};
 //# sourceMappingURL=AzureCommunicationCallAdapter.d.ts.map