@azure/communication-react 1.3.2-alpha-202208110020.0 → 1.3.2-beta.1

package/dist/communication-react.d.ts

@@ -361,6 +361,16 @@ export declare interface BaseCustomStyles {
 export declare interface CallAdapter extends AdapterState<CallAdapterState>, Disposable, CallAdapterCallManagement, CallAdapterDeviceManagement, CallAdapterSubscribers {
 }
 
+/**
+ * Payload for {@link CallEndedListener} containing details on the ended call.
+ *
+ * @public
+ */
+export declare type CallAdapterCallEndedEvent = {
+    callId?: string;
+    callEndReason?: CallEndReason;
+};
+
 /**
  * Functionality for managing the current call.
  *
@@ -419,6 +429,12 @@ export declare interface CallAdapterCallManagement {
      * @public
      */
     startCall(participants: string[], options?: StartCallOptions): Call | undefined;
+    /**
+     * Start the call.
+     * @param participants - An array of {@link @azure/communication-common#CommunicationIdentifier} to be called
+     * @beta
+     */
+    startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): Call | undefined;
     /**
      * Start sharing the screen during a call.
      *
@@ -439,6 +455,12 @@ export declare interface CallAdapterCallManagement {
      * @public
      */
     removeParticipant(userId: string): Promise<void>;
+    /**
+     * Remove a participant from the call.
+     * @param participant - {@link @azure/communication-common#CommunicationIdentifier} of the participant to be removed
+     * @beta
+     */
+    removeParticipant(participant: CommunicationIdentifier): Promise<void>;
     /**
      * Create the html view for a stream.
      *
@@ -480,7 +502,14 @@ export declare interface CallAdapterCallManagement {
      *
      * @beta
      */
-    addParticipant(participant: CommunicationIdentifier, options?: AddPhoneNumberOptions): Promise<void>;
+    addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>;
+    addParticipant(participant: CommunicationUserIdentifier): Promise<void>;
+    /**
+     * send dtmf tone to another participant in a 1:1 PSTN call
+     *
+     * @beta
+     */
+    sendDtmfTone(dtmfTone: DtmfTone_2): Promise<void>;
 }
 
 /**
@@ -924,6 +953,7 @@ export declare type CallCompositeIcons = {
     PeoplePaneAddPerson?: JSX.Element;
     PeoplePaneOpenDialpad?: JSX.Element;
     DialpadStartCall?: JSX.Element;
+    NoticePageInvalidRoom?: JSX.Element;
 };
 
 /**
@@ -951,7 +981,7 @@ export declare type CallCompositeOptions = {
  *
  * @public
  */
-export declare type CallCompositePage = 'accessDeniedTeamsMeeting' | 'call' | 'configuration' | 'joinCallFailedDueToNoNetwork' | 'leftCall' | 'lobby' | 'removedFromCall';
+export declare type CallCompositePage = 'accessDeniedTeamsMeeting' | 'call' | 'configuration' | /* @conditional-compile-remove(PSTN-calls) */ 'hold' | 'joinCallFailedDueToNoNetwork' | 'leftCall' | 'lobby' | /* @conditional-compile-remove(rooms) */ 'deniedPermissionToRoom' | 'removedFromCall' | /* @conditional-compile-remove(rooms) */ 'roomNotFound';
 
 /**
  * Props for {@link CallComposite}.
@@ -1217,6 +1247,66 @@ export declare interface CallCompositeStrings {
      * Aria Label for dialpad Modal close button
      */
     dialpadCloseModalButtonAriaLabel: string;
+    /**
+     * label for more button in the Calling composite
+     */
+    moreButtonCallingLabel: string;
+    /**
+     * Label for the resume call button on the hold pane
+     */
+    resumeCallButtonLabel: string;
+    /**
+     * Label for the resume call button on the hold pane when call is resuming
+     */
+    resumingCallButtonLabel: string;
+    /**
+     * Aria label for the resume call button on the hold pane
+     */
+    resumeCallButtonAriaLabel: string;
+    /**
+     * Aria label for the resume call button on the hold pane when call is resuming
+     */
+    resumingCallButtonAriaLabel: string;
+    /**
+     * Label for the hold pane
+     */
+    holdScreenLabel: string;
+    /**
+     * Placeholder text for dtmf dialpad
+     */
+    dtmfDialpadPlaceHolderText: string;
+    /**
+     * Label for the button to open dtmf dialpad
+     */
+    openDtmfDialpadLabel: string;
+    /**
+     * aria label for when the invite link has been actioned
+     */
+    copyInviteLinkActionedAriaLabel: string;
+    /**
+     * Title text of the page shown to the user when the user attempts to join a room that cannot be found.
+     */
+    roomNotFoundTitle: string;
+    /**
+     * More details text of the page shown to the user when the user attempts to join a room that cannot be found.
+     */
+    roomNotFoundDetails?: string;
+    /**
+     * Title text of the page shown to the user when the user attempts to join a room to which they are not invited.
+     */
+    deniedPermissionToRoomTitle: string;
+    /**
+     * More details text of the page shown to the user when the user attempts to join a room to which they are not invited.
+     */
+    deniedPermissionToRoomDetails?: string;
+    /**
+     * Control bar People button ToolTipContent
+     */
+    peopleButtonTooltipOpen: string;
+    /**
+     * Control bar People button ToolTipContent
+     */
+    peopleButtonTooltipClose: string;
 }
 
 /**
@@ -1246,7 +1336,9 @@ export declare type CallControlOptions = {
      * Show or Hide Camera Button during a call
      * @defaultValue true
      */
-    cameraButton?: boolean;
+    cameraButton?: boolean | /* @conditional-compile-remove(PSTN-calls) */ {
+        disabled: boolean;
+    };
     /**
      * Show or Hide EndCall button during a call.
      * @defaultValue true
@@ -1256,12 +1348,16 @@ export declare type CallControlOptions = {
      * Show or Hide Microphone button during a call.
      * @defaultValue true
      */
-    microphoneButton?: boolean;
+    microphoneButton?: boolean | /* @conditional-compile-remove(PSTN-calls) */ {
+        disabled: boolean;
+    };
     /**
      * Show or Hide Devices button during a call.
      * @defaultValue true
      */
-    devicesButton?: boolean;
+    devicesButton?: boolean | /* @conditional-compile-remove(PSTN-calls) */ {
+        disabled: boolean;
+    };
     /**
      * Show, Hide or Disable participants button during a call.
      * @defaultValue true
@@ -1276,12 +1372,20 @@ export declare type CallControlOptions = {
     screenShareButton?: boolean | {
         disabled: boolean;
     };
+    /**
+     * Show, Hide or disable the more button during a call.
+     * @defaultValue true
+     */
+    moreButton?: boolean;
     /**
      * Inject custom buttons in the call controls.
      *
      * @beta
      */
     onFetchCustomButtonProps?: CustomCallControlButtonCallback[];
+    holdButton?: boolean | {
+        disabled: boolean;
+    };
 };
 
 /**
@@ -1289,9 +1393,7 @@ export declare type CallControlOptions = {
  *
  * @public
  */
-export declare type CallEndedListener = (event: {
-    callId: string;
-}) => void;
+export declare type CallEndedListener = (event: CallAdapterCallEndedEvent) => void;
 
 /**
  * Error thrown from failed stateful API methods.
@@ -1345,7 +1447,7 @@ export declare type CallErrors = {
  *
  * @public
  */
-export declare type CallErrorTarget = 'Call.addParticipant' | 'Call.feature' | 'Call.hangUp' | 'Call.hold' | 'Call.mute' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.muteIncomingAudio' | 'Call.off' | 'Call.on' | 'Call.removeParticipant' | 'Call.resume' | 'Call.sendDtmf' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.startAudio' | 'Call.startScreenSharing' | 'Call.startVideo' | 'Call.stopScreenSharing' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.stopAudio' | 'Call.stopVideo' | 'Call.unmute' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.unmuteIncomingAudio' | 'CallAgent.dispose' | 'CallAgent.feature' | 'CallAgent.join' | 'CallAgent.off' | 'CallAgent.on' | 'CallAgent.startCall' | 'CallClient.createCallAgent' | 'CallClient.feature' | 'CallClient.getDeviceManager' | /* @conditional-compile-remove(calling-beta-sdk) */ 'CallClient.getEnvironmentInfo' | 'DeviceManager.askDevicePermission' | 'DeviceManager.getCameras' | 'DeviceManager.getMicrophones' | 'DeviceManager.getSpeakers' | 'DeviceManager.off' | 'DeviceManager.on' | 'DeviceManager.selectMicrophone' | 'DeviceManager.selectSpeaker' | 'IncomingCall.accept' | 'IncomingCall.reject';
+export declare type CallErrorTarget = 'Call.addParticipant' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.dispose' | 'Call.feature' | 'Call.hangUp' | 'Call.hold' | 'Call.mute' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.muteIncomingAudio' | 'Call.off' | 'Call.on' | 'Call.removeParticipant' | 'Call.resume' | 'Call.sendDtmf' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.startAudio' | 'Call.startScreenSharing' | 'Call.startVideo' | 'Call.stopScreenSharing' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.stopAudio' | 'Call.stopVideo' | 'Call.unmute' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.unmuteIncomingAudio' | 'CallAgent.dispose' | 'CallAgent.feature' | 'CallAgent.join' | 'CallAgent.off' | 'CallAgent.on' | 'CallAgent.startCall' | 'CallClient.createCallAgent' | /* @conditional-compile-remove(calling-beta-sdk) */ 'CallClient.createTeamsCallAgent' | 'CallClient.feature' | 'CallClient.getDeviceManager' | /* @conditional-compile-remove(calling-beta-sdk) */ 'CallClient.getEnvironmentInfo' | 'DeviceManager.askDevicePermission' | 'DeviceManager.getCameras' | 'DeviceManager.getMicrophones' | 'DeviceManager.getSpeakers' | 'DeviceManager.off' | 'DeviceManager.on' | 'DeviceManager.selectMicrophone' | 'DeviceManager.selectSpeaker' | 'IncomingCall.accept' | 'IncomingCall.reject';
 
 /**
  * Callback for {@link CallAdapterSubscribers} 'callIdChanged' event.
@@ -1386,13 +1488,15 @@ export declare type CallingHandlers = {
     onToggleScreenShare: () => Promise<void>;
     onHangUp: () => Promise<void>;
     onToggleHold: () => Promise<void>;
-    onAddParticipant: (participant: CommunicationIdentifier, options?: AddPhoneNumberOptions) => Promise<void>;
+    onAddParticipant(participant: CommunicationUserIdentifier): Promise<void>;
+    onAddParticipant(participant: PhoneNumberIdentifier, options: AddPhoneNumberOptions): Promise<void>;
     onCreateLocalStreamView: (options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>;
     onCreateRemoteStreamView: (userId: string, options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>;
-    onRemoveParticipant: (userId: string) => Promise<void>;
+    onRemoveParticipant(userId: string): Promise<void>;
+    onRemoveParticipant(participant: CommunicationIdentifier): Promise<void>;
     onDisposeRemoteStreamView: (userId: string) => Promise<void>;
     onDisposeLocalStreamView: () => Promise<void>;
-    onSendDtmfTone?: (dtmfTone: DtmfTone_2) => Promise<void>;
+    onSendDtmfTone: (dtmfTone: DtmfTone_2) => Promise<void>;
 };
 
 /**
@@ -1446,7 +1550,7 @@ export declare type CallParticipantListParticipant = ParticipantListParticipant
  * @beta
  */
 export declare type CallParticipantsLocator = {
-    participantIDs: string[];
+    participantIds: string[];
 };
 
 /**
@@ -1584,6 +1688,12 @@ export declare interface CallWithChatAdapterManagement {
      * @public
      */
     removeParticipant(userId: string): Promise<void>;
+    /**
+     * Remove a participant from the call.
+     * @param participant - {@link @azure/communication-common#CommunicationIdentifier} of the participant to be removed
+     * @beta
+     */
+    removeParticipant(participant: CommunicationIdentifier): Promise<void>;
     /**
      * Join the call with microphone initially on/off.
      *
@@ -1638,6 +1748,12 @@ export declare interface CallWithChatAdapterManagement {
      * @public
      */
     startCall(participants: string[], options?: StartCallOptions): Call | undefined;
+    /**
+     * Start the call.
+     * @param participants - An array of {@link @azure/communication-common#CommunicationIdentifier} to be called
+     * @beta
+     */
+    startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): Call | undefined;
     /**
      * Start sharing the screen during a call.
      *
@@ -1821,7 +1937,14 @@ export declare interface CallWithChatAdapterManagement {
      *
      * @beta
      */
-    addParticipant: (participant: CommunicationIdentifier, options?: AddPhoneNumberOptions) => Promise<void>;
+    addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>;
+    addParticipant(participant: CommunicationUserIdentifier): Promise<void>;
+    /**
+     * send dtmf tone to another participant in the call in 1:1 calls
+     *
+     * @beta
+     */
+    sendDtmfTone: (dtmfTone: DtmfTone_2) => Promise<void>;
 }
 
 /**
@@ -2188,6 +2311,18 @@ export declare interface CallWithChatCompositeStrings {
      * Aria Label for dialpad Modal close button
      */
     dialpadCloseModalButtonAriaLabel: string;
+    /**
+     * Placeholder text for dtmf dialpad
+     */
+    dtmfDialpadPlaceHolderText: string;
+    /**
+     * Label for the button to open dtmf dialpad
+     */
+    openDtmfDialpadLabel: string;
+    /**
+     * aria label for when the invite link has been actioned
+     */
+    copyInviteLinkActionedAriaLabel: string;
 }
 
 /**
@@ -2210,12 +2345,16 @@ export declare interface CallWithChatControlOptions {
      * Show or Hide Microphone button during a call.
      * @defaultValue true
      */
-    microphoneButton?: boolean;
+    microphoneButton?: boolean | /* @conditional-compile-remove(PSTN-calls) */ {
+        disabled: boolean;
+    };
     /**
      * Show or Hide Camera Button during a call
      * @defaultValue true
      */
-    cameraButton?: boolean;
+    cameraButton?: boolean | /* @conditional-compile-remove(PSTN-calls) */ {
+        disabled: boolean;
+    };
     /**
      * Show, Hide or Disable the screen share button during a call.
      * @defaultValue true
@@ -2232,18 +2371,32 @@ export declare interface CallWithChatControlOptions {
      * Show or hide the chat button in the call-with-chat composite control bar.
      * @defaultValue true
      */
-    chatButton?: boolean;
+    chatButton?: boolean | /* @conditional-compile-remove(PSTN-calls) */ {
+        disabled: boolean;
+    };
     /**
      * Show or hide the people button in the call-with-chat composite control bar.
      * @defaultValue true
      */
-    peopleButton?: boolean;
+    peopleButton?: boolean | /* @conditional-compile-remove(PSTN-calls) */ {
+        disabled: boolean;
+    };
     /**
      * Inject custom buttons in the call controls.
      *
      * @beta
      */
     onFetchCustomButtonProps?: CustomCallWithChatControlButtonCallback[];
+    /**
+     * Show or hide the more button in the call-with-chat control bar.
+     */
+    moreButton?: boolean;
+    /**
+     * Show or hide the hold button in the bottom sheet drawer
+     */
+    holdButton?: boolean | {
+        disabled: boolean;
+    };
 }
 
 /**
@@ -3133,6 +3286,8 @@ export declare interface ComponentStrings {
     dialpad: DialpadStrings;
     /** Strings for VideoTile */
     videoTile: VideoTileStrings;
+    /** Strings for HoldButton */
+    holdButton: HoldButtonStrings;
 }
 
 /**
@@ -3699,6 +3854,9 @@ export declare interface CustomCallWithChatControlButtonProps extends CustomCont
  * @beta
  */
 export declare interface CustomControlButtonProps {
+    /**
+     * Calback for when button is clicked
+     */
     onItemClick?: () => void;
     /**
      * Whether the buttons is disabled
@@ -3718,6 +3876,22 @@ export declare interface CustomControlButtonProps {
      * Optional label for the button
      */
     text?: string;
+    /**
+     * A unique key for the button
+     */
+    key?: string | number;
+    /**
+     * The aria label of the button for the benefit of screen readers.
+     */
+    ariaLabel?: string;
+    /**
+     * Detailed description of the button for the benefit of screen readers.
+     */
+    ariaDescription?: string;
+    /**
+     * A unique id set for the standard HTML id attibute
+     */
+    id?: string;
 }
 
 /**
@@ -3777,6 +3951,7 @@ export declare const DEFAULT_COMPONENT_ICONS: {
     ControlButtonMicOn: JSX.Element;
     ControlButtonOptions: JSX.Element;
     ControlButtonParticipants: JSX.Element;
+    ControlButtonParticipantsContextualMenuItem: JSX.Element;
     ControlButtonScreenShareStart: JSX.Element;
     ControlButtonScreenShareStop: JSX.Element;
     CancelFileUpload: JSX.Element;
@@ -3813,7 +3988,8 @@ export declare const DEFAULT_COMPONENT_ICONS: {
     ParticipantItemOptions: JSX.Element;
     ParticipantItemOptionsHovered: JSX.Element;
     ParticipantItemScreenShareStart: JSX.Element;
-    HoldCall: JSX.Element;
+    HoldCallContextualMenuItem: JSX.Element;
+    HoldCallButton: JSX.Element;
     ResumeCall: JSX.Element;
     SendBoxSend: JSX.Element;
     SendBoxSendHovered: JSX.Element;
@@ -3885,6 +4061,7 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     PeoplePaneAddPerson?: JSX.Element | undefined;
     PeoplePaneOpenDialpad?: JSX.Element | undefined;
     DialpadStartCall?: JSX.Element | undefined;
+    NoticePageInvalidRoom?: JSX.Element | undefined;
     ChevronLeft?: JSX.Element | undefined;
     ControlBarChatButtonActive?: JSX.Element | undefined;
     ControlBarChatButtonInactive?: JSX.Element | undefined;
@@ -3896,12 +4073,14 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     MoreDrawerSelectedSpeaker?: JSX.Element | undefined;
     MoreDrawerSpeakers?: JSX.Element | undefined;
     ChatMessageOptions: JSX.Element;
+    ControlButtonParticipantsContextualMenuItem: JSX.Element;
     CancelFileUpload: JSX.Element;
     DownloadFile: JSX.Element;
     ErrorBarCallVideoRecoveredBySystem: JSX.Element;
     ErrorBarCallVideoStoppedBySystem: JSX.Element;
     MessageResend: JSX.Element;
-    HoldCall: JSX.Element;
+    HoldCallContextualMenuItem: JSX.Element;
+    HoldCallButton: JSX.Element;
     ResumeCall: JSX.Element;
     BackSpace: JSX.Element;
 };
@@ -4132,18 +4311,6 @@ export declare interface DiagnosticsCallFeatureState {
  */
 export declare const Dialpad: (props: DialpadProps) => JSX.Element;
 
-/**
- * Type for  {@link DialpadButton} input
- *
- * @beta
- */
-export declare interface DialpadButtonProps {
-    /** Number displayed on each dialpad button */
-    primaryContent: string;
-    /** Letters displayed on each dialpad button */
-    secondaryContent?: string;
-}
-
 /**
  * Props for {@link Dialpad} component.
  *
@@ -4155,10 +4322,14 @@ export declare interface DialpadProps {
     onSendDtmfTone?: (dtmfTone: DtmfTone) => Promise<void>;
     /**  Callback for dialpad button behavior*/
     onClickDialpadButton?: (buttonValue: string, buttonIndex: number) => void;
-    /**  customize dialpad input formatting */
-    onDisplayDialpadInput?: (input: string) => string;
-    /**  on change function for text field */
+    /** set dialpad textfield content */
+    textFieldValue?: string;
+    /**  on change function for text field, provides an unformatted plain text*/
     onChange?: (input: string) => void;
+    /**  boolean input to determine when to show/hide delete button, default true */
+    showDeleteButton?: boolean;
+    /**  boolean input to determine if dialpad is in mobile view, default false */
+    isMobile?: boolean;
     styles?: DialpadStyles;
 }
 
@@ -4169,7 +4340,7 @@ export declare interface DialpadProps {
  */
 export declare interface DialpadStrings {
     placeholderText: string;
-    deleteButtonAriaLabel: string;
+    deleteButtonAriaLabel?: string;
 }
 
 /**
@@ -4181,8 +4352,8 @@ export declare interface DialpadStyles {
     root?: IStyle;
     button?: IButtonStyles;
     textField?: Partial<ITextFieldStyles>;
-    primaryContent?: IStyle;
-    secondaryContent?: IStyle;
+    digit?: IStyle;
+    letter?: IStyle;
     deleteIcon?: IButtonStyles;
 }
 
@@ -4784,7 +4955,7 @@ export declare interface HoldButtonStrings {
     /**
      * Content for when button is unchecked
      */
-    toolTipOffContent: string;
+    tooltipOffContent: string;
 }
 
 /**
@@ -6981,7 +7152,13 @@ export declare const useChatThreadClient: () => ChatThreadClient;
 export declare const useDeviceManager: () => StatefulDeviceManager | undefined;
 
 /**
- * Primary hook to get all hooks necessary for a React Component from this library..
+ * Primary hook to get all hooks necessary for a React Component from this library.
+ *
+ * To call this hook, the component requires to be wrapped under these providers:
+ *
+ * 1. For chat components: {@link ChatClientProvider} and {@link ChatThreadClientProvider}.
+ *
+ * 2. For calling components: {@link CallClientProvider}, {@link CallAgentProvider} and {@link CallAgentProvider}.
  *
  * Most straightforward usage of a components looks like:
  *