@azure/communication-react 1.13.0-alpha-202402040013 → 1.13.0-alpha-202402070012

package/dist/communication-react.d.ts

@@ -75,6 +75,7 @@ import { LatestNetworkDiagnostics } from '@azure/communication-calling';
 import { LocalVideoStream } from '@azure/communication-calling';
 import type { MediaDiagnosticChangedEventArgs } from '@azure/communication-calling';
 import { MediaStreamType } from '@azure/communication-calling';
+import { MicrosoftTeamsAppIdentifier } from '@azure/communication-common';
 import { MicrosoftTeamsUserIdentifier } from '@azure/communication-common';
 import type { NetworkDiagnosticChangedEventArgs } from '@azure/communication-calling';
 import { PartialTheme } from '@fluentui/react';
@@ -104,6 +105,7 @@ import { TeamsMeetingLinkLocator } from '@azure/communication-calling';
 import { Theme } from '@fluentui/react';
 import { TransferRequestedEventArgs } from '@azure/communication-calling';
 import { TypingIndicatorReceivedEvent } from '@azure/communication-chat';
+import { UnknownIdentifier } from '@azure/communication-common';
 import { VideoDeviceInfo } from '@azure/communication-calling';
 import { VideoEffectName } from '@azure/communication-calling';
 import { VideoStreamRenderer } from '@azure/communication-calling';
@@ -383,6 +385,31 @@ export declare type AzureCommunicationChatAdapterOptions = {
     credential?: CommunicationTokenCredential;
 };
 
+/**
+ * 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 declare type AzureCommunicationOutboundCallAdapterArgs = {
+    userId: CommunicationUserIdentifier;
+    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
+     */
+    options?: AzureCommunicationCallAdapterOptions;
+};
+
 /**
  * Properties common to all composites exported from this library.
  *
@@ -624,9 +651,9 @@ export declare interface CallAdapter extends CommonCallAdapter {
     /**
      * Start the call.
      * @param participants - An array of {@link @azure/communication-common#CommunicationIdentifier} to be called
-     * @beta
+     * @public
      */
-    startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): Call | undefined;
+    startCall(participants: StartCallIdentifier[], options?: StartCallOptions): Call | undefined;
 }
 
 /**
@@ -674,9 +701,9 @@ export declare interface CallAdapterCallManagement extends CallAdapterCallOperat
     /**
      * Start the call.
      * @param participants - An array of {@link @azure/communication-common#CommunicationIdentifier} to be called
-     * @beta
+     * @public
      */
-    startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): Call | undefined;
+    startCall(participants: StartCallIdentifier[], options?: StartCallOptions): Call | undefined;
 }
 
 /**
@@ -838,7 +865,7 @@ export declare interface CallAdapterCallOperations {
     /**
      * send dtmf tone to another participant in a 1:1 PSTN call
      *
-     * @beta
+     * @public
      */
     sendDtmfTone(dtmfTone: DtmfTone_2): Promise<void>;
     /**
@@ -1584,9 +1611,10 @@ export declare type CallCompositeOptions = {
          */
         disableSurvey?: boolean;
         /**
-         * Optional callback to add extra logic when survey is dismissed. For self-host only
+         * Optional callback to redirect users to custom screens when survey is done, note that default end call screen will be shown if this callback is not provided
+         * This callback can be used to redirect users to different screens depending on survey state, whether it is submitted, skipped or has a problem when submitting the survey
          */
-        onSurveyDismissed?: () => void;
+        onSurveyClosed?: (surveyState: 'sent' | 'skipped' | 'error', surveyError?: string) => void;
         /**
          * Optional callback to handle survey data including free form text response
          * Note that free form text response survey option is only going to be enabled when this callback is provided
@@ -2276,9 +2304,9 @@ export declare interface CallCompositeStrings {
      */
     capabilityChangedNotification?: CapabilityChangedNotificationStrings;
     /**
-     * Question for the survey
+     * Title for the survey
      */
-    surveyQuestion: string;
+    surveyTitle: string;
     /**
      * Helper text to explain what the survey is for
      */
@@ -2324,13 +2352,17 @@ export declare interface CallCompositeStrings {
      */
     surveyConfirmButtonLabel: string;
     /**
-     * Aria Label for cancel button
+     * Cancel button label for survey
      */
-    surveyCancelButtonAriaLabel: string;
+    surveySkipButtonLabel: string;
     /**
      * Default text for free form text box
      */
     surveyTextboxDefaultText: string;
+    /**
+     * Thank you text appeared on screen after survey is submitted
+     */
+    endOfSurveyText: string;
     /**
      * Corresponding texts to each call issue
      */
@@ -2387,6 +2419,10 @@ export declare interface CallCompositeStrings {
      * Label to hide the dtmf dialer in the more button menu
      */
     dtmfDialerMoreButtonLabelOff?: string;
+    /**
+     * Strings for spotlight prompt
+     */
+    spotlightPrompt: SpotlightPromptStrings;
 }
 
 /**
@@ -2878,9 +2914,9 @@ export declare interface CallWithChatAdapterManagement {
     /**
      * Start the call.
      * @param participants - An array of {@link @azure/communication-common#CommunicationIdentifier} to be called
-     * @beta
+     * @public
      */
-    startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): Call | undefined;
+    startCall(participants: (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): Call | undefined;
     /**
      * Start sharing the screen during a call.
      *
@@ -3116,7 +3152,7 @@ export declare interface CallWithChatAdapterManagement {
     /**
      * send dtmf tone to another participant in the call in 1:1 calls
      *
-     * @beta
+     * @public
      */
     sendDtmfTone: (dtmfTone: DtmfTone_2) => Promise<void>;
     /**
@@ -3511,9 +3547,10 @@ export declare type CallWithChatCompositeOptions = {
          */
         disableSurvey?: boolean;
         /**
-         * Optional callback to add extra logic when survey is dismissed. For self-host only
+         * Optional callback to redirect users to custom screens when survey is done, note that default end call screen will be shown if this callback is not provided
+         * This callback can be used to redirect users to different screens depending on survey state, whether it is submitted, skipped or has a problem when submitting the survey
          */
-        onSurveyDismissed?: () => void;
+        onSurveyClosed?: (surveyState: 'sent' | 'skipped' | 'error', surveyError?: string) => void;
         /**
          * Optional callback to handle survey data including free form text response
          * Note that free form text response survey option is only going to be enabled when this callback is provided
@@ -4855,9 +4892,9 @@ export declare interface CommonCallAdapter extends AdapterState<CallAdapterState
     /**
      * Start the call.
      * @param participants - An array of {@link @azure/communication-common#CommunicationIdentifier} to be called
-     * @beta
+     * @public
      */
-    startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): void;
+    startCall(participants: StartCallIdentifier[], options?: StartCallOptions): void;
 }
 
 /**
@@ -4883,6 +4920,11 @@ export declare type CommonCallAdapterOptions = {
      * Sounds to use for calling events
      */
     callingSounds?: CallingSounds;
+    /**
+     * Reaction resource for reaction resources
+     * @beta
+     */
+    reactionResources?: ReactionResources;
 };
 
 /**
@@ -5004,6 +5046,9 @@ export declare interface CommonCallingHandlers {
     onRaiseHand: () => Promise<void>;
     onLowerHand: () => Promise<void>;
     onToggleRaiseHand: () => Promise<void>;
+    /**
+     * @beta
+     */
     onReactionClicked: (reaction: Reaction_2) => Promise<void>;
     onToggleHold: () => Promise<void>;
     onAddParticipant(participant: CommunicationUserIdentifier): Promise<void>;
@@ -5309,8 +5354,8 @@ export declare interface ComponentStrings {
     sendBox: SendBoxStrings;
     /** Strings for MentionPopover */
     mentionPopover: MentionPopoverStrings;
-    /** Strings for ImageGallery */
-    imageGallery: ImageGalleryStrings;
+    /** Strings for ImageOverlay */
+    imageOverlay: ImageOverlayStrings;
     /** Strings for MessageStatusIndicator */
     messageStatusIndicator: MessageStatusIndicatorStrings;
     /** Strings for ErroBar */
@@ -5727,7 +5772,28 @@ export declare interface ControlBarProps {
  *
  * @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>;
+
+/**
+ * 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.
+ *
+ * @public
+ */
+export declare function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, targetCallees: StartCallIdentifier[], options?: AzureCommunicationCallAdapterOptions): Promise<CallAdapter>;
 
 /**
  * Create a {@link CallAdapter} using the provided {@link StatefulCallClient}.
@@ -5737,7 +5803,7 @@ export declare const createAzureCommunicationCallAdapter: ({ userId, displayName
  *
  * @public
  */
-export declare const createAzureCommunicationCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator, options?: AzureCommunicationCallAdapterOptions) => Promise<CallAdapter>;
+export declare function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator, options?: AzureCommunicationCallAdapterOptions): Promise<CallAdapter>;
 
 /**
  * Create a CallWithChatAdapter backed by Azure Communication services
@@ -6042,7 +6108,7 @@ export declare interface CustomMessage extends MessageCommon {
  *
  * @public
  */
-export declare const darkTheme: PartialTheme & CallingTheme & /* @conditional-compile-remove(image-gallery) */ ChatTheme;
+export declare const darkTheme: PartialTheme & CallingTheme & /* @conditional-compile-remove(image-overlay) */ ChatTheme;
 
 /**
  * @beta
@@ -6552,20 +6618,20 @@ export declare interface DiagnosticsCallFeatureState {
  * A component to allow users to enter phone number through clicking on dialpad/using keyboard
  * It will return empty component for stable builds
  *
- * @beta
+ * @public
  */
 export declare const Dialpad: (props: DialpadProps) => JSX.Element;
 
 /**
  * Modes of the dialpad component.
- * @beta
+ * @public
  */
 export declare type DialpadMode = 'dtmf' | 'dialer';
 
 /**
  * Props for {@link Dialpad} component.
  *
- * @beta
+ * @public
  */
 export declare interface DialpadProps {
     strings?: DialpadStrings;
@@ -6614,7 +6680,7 @@ export declare interface DialpadProps {
 /**
  * Strings of {@link Dialpad} that can be overridden.
  *
- * @beta
+ * @public
  */
 export declare interface DialpadStrings {
     placeholderText: string;
@@ -6624,7 +6690,7 @@ export declare interface DialpadStrings {
 /**
  * Styles for {@link Dialpad} component.
  *
- * @beta
+ * @public
  */
 export declare interface DialpadStyles {
     root?: IStyle;
@@ -6659,7 +6725,7 @@ export { Disposable_2 as Disposable }
 /**
  * DTMF tone for PSTN calls.
  *
- * @beta
+ * @public
  */
 export declare type DtmfTone = 'A' | 'B' | 'C' | 'D' | 'Flash' | 'Num0' | 'Num1' | 'Num2' | 'Num3' | 'Num4' | 'Num5' | 'Num6' | 'Num7' | 'Num8' | 'Num9' | 'Pound' | 'Star';
 
@@ -7369,70 +7435,60 @@ export declare interface _Identifiers {
  *
  * @beta
  */
-export declare const ImageGallery: (props: ImageGalleryProps) => JSX.Element;
+export declare const ImageOverlay: (props: ImageOverlayProps) => JSX.Element;
 
 /**
- * Props for {@link ImageGallery}.
+ * Props for {@link ImageOverlay}.
  *
  * @beta
  */
-export declare interface ImageGalleryImageProps {
-    /** Image Url used to display the image in a large scale. */
-    imageUrl: string;
-    /** String used as a file name when downloading this image to user's local device. */
-    downloadFilename: string;
-    /** Optional string used as a alt text for the image. @default 'image' */
-    altText?: string;
-    /** Optional string used as the title of the image and displayed on the top left corner of the ImageGallery. */
-    title?: string;
-    /** Optional JSX element used as a title icon and displayed to the left of the title element. */
-    titleIcon?: JSX.Element;
-}
-
-/**
- * Props for {@link ImageGallery}.
- *
- * @beta
- */
-export declare interface ImageGalleryProps {
+export declare interface ImageOverlayProps {
     /**
      * Boolean that controls whether the modal is displayed.
      */
     isOpen: boolean;
     /**
-     * Array of images used to populate the ImageGallery
+     * Image source used to display the image in a large scale.
+     */
+    imageSrc: string;
+    /**
+     * Optional string used as a alt text for the image. @default 'image'
+     */
+    altText?: string;
+    /**
+     * Optional string used as the title of the image and displayed on the top left corner of the ImageOverlay.
+     */
+    title?: string;
+    /**
+     * Optional JSX element used as a title icon and displayed to the left of the title element.
      */
-    images: Array<ImageGalleryImageProps>;
+    titleIcon?: JSX.Element;
     /**
-     * Callback to invoke when the ImageGallery modal is dismissed
+     * Callback to invoke when the ImageOverlay modal is dismissed
      */
     onDismiss: () => void;
     /**
      * Callback called when the download button is clicked.
      */
-    onImageDownloadButtonClicked: (imageUrl: string, downloadFilename: string) => void;
+    onDownloadButtonClicked: (imageSrc: string) => void;
     /**
      * Callback called when there's an error loading the image.
      */
     onError?: (event: SyntheticEvent<HTMLImageElement, Event>) => void;
-    /**
-     * Indicating which index of the images array to start with.
-     */
-    startIndex?: number;
 }
 
 /**
- * Strings of {@link ImageGallery} that can be overridden.
+ * Strings of {@link ImageOverlay} that can be overridden.
  *
  * @beta
  */
-export declare interface ImageGalleryStrings {
+export declare interface ImageOverlayStrings {
     /**
-     * Download button label for ImageGallery
+     * Download button label for ImageOverlay
      */
     downloadButtonLabel: string;
     /**
-     * Dismiss button aria label for ImageGallery
+     * Dismiss button aria label for ImageOverlay
      */
     dismissButtonAriaLabel: string;
 }
@@ -7623,7 +7679,7 @@ export declare interface JumpToNewMessageButtonProps {
  *
  * @public
  */
-export declare const lightTheme: PartialTheme & CallingTheme & /* @conditional-compile-remove(image-gallery) */ ChatTheme;
+export declare const lightTheme: PartialTheme & CallingTheme & /* @conditional-compile-remove(image-overlay) */ ChatTheme;
 
 /**
  * Whether the stream is loading or not.
@@ -7712,7 +7768,7 @@ export declare interface LocalVideoStreamVideoEffectsState {
 /**
  * Options for the local video tile in the Call composite.
  *
- * @beta
+ * @public
  */
 export declare interface LocalVideoTileOptions {
     /**
@@ -7736,7 +7792,7 @@ export declare type LocalVideoTileSize = '9:16' | '16:9' | 'hidden' | 'followDev
 
 /**
  * Modes of how the longpress handlers can be tiggered.
- * @beta
+ * @public
  */
 export declare type LongPressTrigger = 'mouseAndTouch' | 'touch';
 
@@ -9744,6 +9800,61 @@ export declare interface SpotlightCallFeatureState {
     spotlightedParticipants: SpotlightedParticipant[];
 }
 
+/**
+ * Strings used in prompt related to spotlight
+ * @beta
+ */
+export declare interface SpotlightPromptStrings {
+    /**
+     * Heading for prompt when starting spotlight on participant
+     */
+    startSpotlightHeading: string;
+    /**
+     * Text for prompt when starting spotlight on participant
+     */
+    startSpotlightText: string;
+    /**
+     * Label for button to confirm starting spotlight on local user in prompt
+     */
+    startSpotlightOnSelfText: string;
+    /**
+     * Label for button to confirm starting spotlight on participant in prompt
+     */
+    startSpotlightConfirmButtonLabel: string;
+    /**
+     * Label for button to cancel starting spotlight on participant in prompt
+     */
+    startSpotlightCancelButtonLabel: string;
+    /**
+     * Heading for prompt when stopping spotlight on participant
+     */
+    stopSpotlightHeading: string;
+    /**
+     * Heading for prompt when stopping spotlight on local user
+     */
+    stopSpotlightOnSelfHeading: string;
+    /**
+     * Text for prompt when stopping spotlight on participant
+     */
+    stopSpotlightText: string;
+    /**
+     * Text for prompt when stopping spotlight on local user
+     */
+    stopSpotlightOnSelfText: string;
+    /**
+     * Label for button to confirm stopping spotlight on participant in prompt
+     */
+    stopSpotlightConfirmButtonLabel: string;
+    /**
+     * Label for button to confirm stopping spotlight on local user in prompt
+     */
+    stopSpotlightOnSelfConfirmButtonLabel: string;
+    /**
+     * Label for button to cancel stopping spotlight on participant in prompt
+     */
+    stopSpotlightCancelButtonLabel: string;
+}
+
 /**
  * Spotlight state with order
  *
@@ -9756,6 +9867,12 @@ export declare interface SpotlightState {
     spotlightedOrderPosition?: number;
 }
 
+/**
+ * Identifier types for initiating a call using the CallAdapter
+ * @public
+ */
+export declare type StartCallIdentifier = (MicrosoftTeamsAppIdentifier | /* @conditional-compile-remove(PSTN-calls) */ PhoneNumberIdentifier | /* @conditional-compile-remove(one-to-n-calling) */ CommunicationUserIdentifier | /* @conditional-compile-remove(teams-adhoc-call) */ MicrosoftTeamsUserIdentifier | UnknownIdentifier) | /* @conditional-compile-remove(start-call-beta) */ CommunicationIdentifier;
+
 /**
  * Defines the methods that allow CallClient {@link @azure/communication-calling#CallClient} to be used statefully.
  * The interface provides access to proxied state and also allows registering a handler for state change events. For
@@ -10505,7 +10622,7 @@ export declare type UpdateMessageCallback = (messageId: string, content: string,
  *
  * @public
  */
-export declare const useAzureCommunicationCallAdapter: (args: Partial<AzureCommunicationCallAdapterArgs>, afterCreate?: ((adapter: CallAdapter) => Promise<CallAdapter>) | undefined, beforeDispose?: ((adapter: CallAdapter) => Promise<void>) | undefined) => CallAdapter | undefined;
+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 CallWithChatAdapter}.