@azure/communication-react 1.14.0 → 1.14.1-alpha-202403261958

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

@@ -1,18 +1,26 @@
 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 { CallAgent, GroupCallLocator, TeamsMeetingLinkLocator, AudioDeviceInfo, VideoDeviceInfo, PermissionConstraints, PropertyChangedEvent, RoomCallLocator, StartCallOptions, Call } from '@azure/communication-calling';
+import { Reaction } from '@azure/communication-calling';
 import { StartCaptionsOptions } from '@azure/communication-calling';
-import { RoomCallLocator } 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";
 import { TransferAcceptedListener } from './CallAdapter';
 import { CapabilitiesChangedListener } from './CallAdapter';
+import { SpotlightChangedListener } 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, 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";
+import { CallSurvey, CallSurveyResponse } from '@azure/communication-calling';
 import { CallingSounds } from './CallAdapter';
 type CallTypeOf<AgentType extends CallAgent | BetaTeamsCallAgent> = AgentType extends CallAgent ? Call : TeamsCall;
 /**
@@ -67,20 +75,30 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     stopScreenShare(): Promise<void>;
     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>;
+    startSpotlight(userIds: string[]): Promise<void>;
+    stopSpotlight(userIds: string[]): Promise<void>;
+    stopAllSpotlight(): Promise<void>;
     getState(): CallAdapterState;
     onStateChange(handler: (state: CallAdapterState) => void): void;
     offStateChange(handler: (state: CallAdapterState) => void): void;
@@ -103,6 +121,7 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     on(event: 'transferAccepted', listener: TransferAcceptedListener): void;
     on(event: 'capabilitiesChanged', listener: CapabilitiesChangedListener): void;
     on(event: 'roleChanged', listener: PropertyChangedEvent): void;
+    on(event: 'spotlightChanged', listener: SpotlightChangedListener): void;
     private subscribeToCaptionEvents;
     private unsubscribeFromCaptionEvents;
     private subscribeCallEvents;
@@ -110,6 +129,7 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     private isMyMutedChanged;
     private onRemoteParticipantsUpdated;
     private isScreenSharingOnChanged;
+    private teamsCaptionsReceived;
     private captionsReceived;
     private isCaptionsActiveChanged;
     private isSpokenLanguageChanged;
@@ -117,6 +137,7 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     private transferAccepted;
     private capabilitiesChanged;
     private roleChanged;
+    private spotlightChanged;
     private callIdChanged;
     private resetDiagnosticsForwarder;
     off(event: 'participantsJoined', listener: ParticipantsJoinedListener): void;
@@ -138,15 +159,32 @@ export declare class AzureCommunicationCallAdapter<AgentType extends CallAgent |
     off(event: 'transferAccepted', listener: TransferAcceptedListener): void;
     off(event: 'capabilitiesChanged', listener: CapabilitiesChangedListener): void;
     off(event: 'roleChanged', listener: PropertyChangedEvent): void;
+    off(event: 'spotlightChanged', listener: SpotlightChangedListener): 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;
+export type CallAdapterLocator = TeamsMeetingLinkLocator | GroupCallLocator | RoomCallLocator | /* @conditional-compile-remove(teams-adhoc-call) */ /* @conditional-compile-remove(PSTN-calls) */ CallParticipantsLocator;
 /**
  * Common optional parameters to create {@link AzureCommunicationCallAdapter} or {@link TeamsCallAdapter}
  *
@@ -160,10 +198,21 @@ 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
      */
     callingSounds?: CallingSounds;
+    /**
+     * Reaction resource for reaction resources
+     * @beta
+     */
+    reactionResources?: ReactionResources;
 };
 /**
  * Optional parameters to create {@link AzureCommunicationCallAdapter}
@@ -183,6 +232,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
      */
@@ -202,6 +256,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
      */
@@ -221,7 +280,7 @@ export type TeamsAdapterOptions = CommonCallAdapterOptions;
 export type TeamsCallAdapterArgs = {
     userId: MicrosoftTeamsUserIdentifier;
     credential: CommunicationTokenCredential;
-    locator: TeamsMeetingLinkLocator;
+    locator: TeamsMeetingLinkLocator | /* @conditional-compile-remove(teams-adhoc-call) */ /* @conditional-compile-remove(PSTN-calls) */ CallParticipantsLocator;
     /**
      * Optional parameters for the {@link TeamsCallAdapter} created
      */
@@ -252,15 +311,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[] | undefined;
+    alternateCallerId?: string | 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}.
  *
@@ -276,6 +340,21 @@ export declare const _createAzureCommunicationCallAdapterInner: ({ userId, displ
  * @public
  */
 export declare const useAzureCommunicationCallAdapter: (args: Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, 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}.
  *
@@ -284,7 +363,7 @@ export declare const useAzureCommunicationCallAdapter: (args: Partial<AzureCommu
  *
  * @public
  */
-export declare function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, targetCallees: StartCallIdentifier[], /* @conditional-compile-remove(video-background-effects) */ options?: AzureCommunicationCallAdapterOptions): Promise<CallAdapter>;
+export declare function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, targetCallees: StartCallIdentifier[], options?: AzureCommunicationCallAdapterOptions): Promise<CallAdapter>;
 /**
  * Create a {@link CallAdapter} using the provided {@link StatefulCallClient}.
  *
@@ -293,6 +372,15 @@ export declare function createAzureCommunicationCallAdapterFromClient(callClient
  *
  * @public
  */
-export declare function 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, locator: CallAdapterLocator, 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?: TeamsAdapterOptions) => Promise<TeamsCallAdapter>;
 export {};
 //# sourceMappingURL=AzureCommunicationCallAdapter.d.ts.map