@azure/communication-react 1.5.1-alpha-202304040013 → 1.5.1-beta.2

package/dist/communication-react.d.ts

@@ -295,10 +295,6 @@ export declare type AzureCommunicationCallAdapterOptions = {
      * {@link CallComposite}. The true role of the user will be synced with ACS services when a Rooms call starts.
      */
     roleHint?: Role;
-    /**
-     * Default set of background images for background image picker.
-     */
-    videoBackgroundImages?: VideoBackgroundImage[];
 };
 
 /**
@@ -397,26 +393,6 @@ export declare interface BaseCustomStyles {
     root?: IStyle;
 }
 
-/**
- * Content blocked message type.
- *
- * Content blocked messages will rendered default value, but applications can provide custom strings and icon to renderers.
- *
- * @beta
- */
-export declare interface BlockedMessage extends MessageCommon {
-    messageType: 'blocked';
-    warningText?: string | false;
-    linkText?: string;
-    link?: string;
-    deletedOn?: Date;
-    senderId?: string;
-    senderDisplayName?: string;
-    status?: MessageStatus;
-    attached?: MessageAttachedStatus;
-    mine?: boolean;
-}
-
 /**
  * @beta
  * Props for BrowserPermissionDeniedIOS component.
@@ -755,14 +731,6 @@ export declare interface CallAdapterCallOperations {
      * @beta
      */
     stopVideoBackgroundEffect(): Promise<void>;
-    /**
-     * Override the background picker images for background replacement effect.
-     *
-     * @param backgroundImages - Array of custom background images.
-     *
-     * @beta
-     */
-    updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[]): void;
 }
 
 /**
@@ -1183,7 +1151,6 @@ export declare const CallComposite: (props: CallCompositeProps) => JSX.Element;
  * @public
  */
 export declare type CallCompositeIcons = {
-    ControlBarPeopleButton?: JSX.Element;
     ControlButtonCameraOff?: JSX.Element;
     ControlButtonCameraOn?: JSX.Element;
     ControlButtonEndCall?: JSX.Element;
@@ -1232,8 +1199,6 @@ export declare type CallCompositeIcons = {
     PeoplePaneOpenDialpad?: JSX.Element;
     DialpadStartCall?: JSX.Element;
     NoticePageInvalidRoom?: JSX.Element;
-    BlurVideoBackground?: JSX.Element;
-    RemoveVideoBackgroundEffect?: JSX.Element;
 };
 
 /**
@@ -1633,26 +1598,6 @@ export declare interface CallCompositeStrings {
      * More details text of the page shown to the user when the user attempts to join a room that cannot be found.
      */
     roomNotFoundDetails?: string;
-    /**
-     * Label for the button to open effects and title of the effects
-     */
-    effects?: string;
-    /**
-     * Label for the blur video background effect item
-     */
-    blurBackgroundEffectButtonLabel?: string;
-    /**
-     * Tooltip text for the blur video background effect item
-     */
-    blurBackgroundTooltip?: string;
-    /**
-     * Label for the remove video background effect item
-     */
-    removeBackgroundEffectButtonLabel?: string;
-    /**
-     * Tooltip text for the blur video background effect item
-     */
-    removeBackgroundTooltip?: string;
     /**
      * Title text of the page shown to the user when the user attempts to join a room to which they are not invited.
      */
@@ -1731,15 +1676,71 @@ export declare type CallControlDisplayType = 'default' | 'compact';
  *
  * @public
  */
-export declare type CallControlOptions = CommonCallControlOptions & {
+export declare type CallControlOptions = {
+    /**
+     * {@link CallControlDisplayType} to change how the call controls are displayed.
+     * `'compact'` display type will decreases the size of buttons and hide the labels.
+     *
+     * @remarks
+     * If the composite `formFactor` is set to `'mobile'`, the control bar will always use compact view.
+     *
+     * @defaultValue 'default'
+     */
+    displayType?: CallControlDisplayType;
+    /**
+     * Show or Hide Camera Button during a call
+     * @defaultValue true
+     */
+    cameraButton?: boolean | /* @conditional-compile-remove(PSTN-calls) */ {
+        disabled: boolean;
+    };
+    /**
+     * Show or Hide EndCall button during a call.
+     * @defaultValue true
+     */
+    endCallButton?: boolean;
+    /**
+     * Show or Hide Microphone button during a call.
+     * @defaultValue true
+     */
+    microphoneButton?: boolean | /* @conditional-compile-remove(PSTN-calls) */ {
+        disabled: boolean;
+    };
+    /**
+     * Show or Hide Devices button during a call.
+     * @defaultValue true
+     */
+    devicesButton?: boolean | /* @conditional-compile-remove(PSTN-calls) */ {
+        disabled: boolean;
+    };
     /**
-     * Show, Hide or Disable participants button during a call. This is the option only work for legacyControl bar.
+     * Show, Hide or Disable participants button during a call.
      * @defaultValue true
      */
     participantsButton?: boolean | {
         disabled: boolean;
     };
-    legacyControlBarExperience?: boolean;
+    /**
+     * Show, Hide or Disable the screen share button during a call.
+     * @defaultValue true
+     */
+    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;
+    };
 };
 
 /**
@@ -2268,7 +2269,6 @@ export declare interface CallWithChatAdapterManagement {
     updateFileUploadErrorMessage: (id: string, errorMessage: string) => void;
     /** @beta */
     updateFileUploadMetadata: (id: string, metadata: FileMetadata) => void;
-    downloadAuthenticatedAttachment?: (attachmentUrl: string) => Promise<string>;
     /**
      * Puts the Call in a Localhold.
      *
@@ -2316,14 +2316,6 @@ export declare interface CallWithChatAdapterManagement {
      * @beta
      */
     stopVideoBackgroundEffect(): Promise<void>;
-    /**
-     * Override the background picker images for background replacement effect.
-     *
-     * @param backgroundImages - Array of custom background images.
-     *
-     * @beta
-     */
-    updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[]): void;
 }
 
 /**
@@ -2438,8 +2430,6 @@ export declare interface CallWithChatClientState {
     alternateCallerId?: string | undefined;
     /** Environment information for system adapter is made on */
     environmentInfo?: EnvironmentInfo;
-    /** Default set of background images for background replacement effect */
-    videoBackgroundImages?: VideoBackgroundImage[];
 }
 
 /**
@@ -2767,11 +2757,47 @@ export declare interface CallWithChatCompositeStrings {
 }
 
 /**
- * Customization options for the control bar in calling with chat experience.
+ * {@link CallWithChatComposite} Call controls to show or hide buttons on the calling control bar.
  *
  * @public
  */
-export declare interface CallWithChatControlOptions extends CommonCallControlOptions {
+export declare interface CallWithChatControlOptions {
+    /**
+     * {@link CallControlDisplayType} to change how the call controls are displayed.
+     * `'compact'` display type will decreases the size of buttons and hide the labels.
+     *
+     * @remarks
+     * If the composite `formFactor` is set to `'mobile'`, the control bar will always use compact view.
+     *
+     * @defaultValue 'default'
+     */
+    displayType?: CallControlDisplayType;
+    /**
+     * Show or Hide Microphone button during a call.
+     * @defaultValue true
+     */
+    microphoneButton?: boolean | /* @conditional-compile-remove(PSTN-calls) */ {
+        disabled: boolean;
+    };
+    /**
+     * Show or Hide Camera Button during a call
+     * @defaultValue true
+     */
+    cameraButton?: boolean | /* @conditional-compile-remove(PSTN-calls) */ {
+        disabled: boolean;
+    };
+    /**
+     * Show, Hide or Disable the screen share button during a call.
+     * @defaultValue true
+     */
+    screenShareButton?: boolean | {
+        disabled: boolean;
+    };
+    /**
+     * Show or Hide EndCall button during a call.
+     * @defaultValue true
+     */
+    endCallButton?: boolean;
     /**
      * Show or hide the chat button in the call-with-chat composite control bar.
      * @defaultValue true
@@ -2779,6 +2805,29 @@ export declare interface CallWithChatControlOptions extends CommonCallControlOpt
     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 | /* @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;
+    };
 }
 
 /**
@@ -3441,7 +3490,6 @@ export declare interface ChatMessage extends MessageCommon {
 export declare type ChatMessageWithStatus = ChatMessage_2 & {
     clientMessageId?: string;
     status: MessageStatus;
-    policyViolation?: boolean;
 };
 
 /**
@@ -3583,85 +3631,6 @@ export declare interface CommonCallAdapter extends AdapterState<CallAdapterState
     startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): void;
 }
 
-/**
- * Customization options for the control bar in calling experience.
- *
- * @public
- */
-export declare type CommonCallControlOptions = {
-    /**
-     * {@link CallControlDisplayType} to change how the call controls are displayed.
-     * `'compact'` display type will decreases the size of buttons and hide the labels.
-     *
-     * @remarks
-     * If the composite `formFactor` is set to `'mobile'`, the control bar will always use compact view.
-     *
-     * @defaultValue 'default'
-     */
-    displayType?: CallControlDisplayType;
-    /**
-     * Show or Hide Camera Button during a call
-     * @defaultValue true
-     */
-    cameraButton?: boolean | /* @conditional-compile-remove(PSTN-calls) */ {
-        disabled: boolean;
-    };
-    /**
-     * Show or Hide EndCall button during a call.
-     * @defaultValue true
-     */
-    endCallButton?: boolean;
-    /**
-     * Show or Hide Microphone button during a call.
-     * @defaultValue true
-     */
-    microphoneButton?: boolean | /* @conditional-compile-remove(PSTN-calls) */ {
-        disabled: boolean;
-    };
-    /**
-     * Show or Hide Devices button during a call.
-     * @defaultValue true
-     */
-    devicesButton?: boolean | /* @conditional-compile-remove(PSTN-calls) */ {
-        disabled: boolean;
-    };
-    /**
-     * Show, Hide or Disable participants button during a call.
-     * @defaultValue true
-     */
-    participantsButton?: boolean | {
-        disabled: boolean;
-    };
-    /**
-     * Show, Hide or Disable the screen share button during a call.
-     * @defaultValue true
-     */
-    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;
-    };
-    /**
-     * Show or hide the people button in the composite control bar.
-     * @defaultValue true
-     */
-    peopleButton?: boolean | /* @conditional-compile-remove(PSTN-calls) */ {
-        disabled: boolean;
-    };
-};
-
 /**
  * Object containing all the handlers required for calling components.
  *
@@ -4264,7 +4233,7 @@ export declare interface ControlBarProps {
  *
  * @public
  */
-export declare const createAzureCommunicationCallAdapter: ({ userId, displayName, credential, locator, alternateCallerId, options }: AzureCommunicationCallAdapterArgs) => Promise<CallAdapter>;
+export declare const createAzureCommunicationCallAdapter: ({ userId, displayName, credential, locator, alternateCallerId }: AzureCommunicationCallAdapterArgs) => Promise<CallAdapter>;
 
 /**
  * Create a {@link CallAdapter} using the provided {@link StatefulCallClient}.
@@ -4445,16 +4414,15 @@ export declare type CustomAvatarOptions = {
 };
 
 /**
- * A callback that returns the props to render a custom {@link ControlBarButton} and {@link DrawerMenuItem}.
+ * A callback that returns the props to render a custom {@link ControlBarButton}.
  *
  * The response indicates where the custom button should be placed.
  *
  * Performance tip: This callback is only called when either the callback or its arguments change.
+ *
  * @beta
  */
-declare type CustomCallControlButtonCallback = (args: CustomCallControlButtonCallbackArgs) => CustomCallWithChatControlButtonProps;
-export { CustomCallControlButtonCallback }
-export { CustomCallControlButtonCallback as CustomCallWithChatControlButtonCallback }
+export declare type CustomCallControlButtonCallback = (args: CustomCallControlButtonCallbackArgs) => CustomCallControlButtonProps;
 
 /**
  * Arguments for {@link CustomCallControlButtonCallback}.
@@ -4471,23 +4439,17 @@ export declare interface CustomCallControlButtonCallbackArgs {
 }
 
 /**
- * Placement for a custom button injected in the {@link CommonCallControlBar}.
+ * Placement for a custom button injected in the {@link CallControls}.
  *
  * 'primary': Place the button(s) on the right end of the center control bar but before the EndCallButton (left end in rtl mode).
- * 'overflow': Place the buttons(s) on the end of the overflow Menu.
- * 'secondary': Place the button(s) on the left end of the side control bar (right in rtl mode).
  *
  * Multiple buttons assigned the same placement are appended in order.
- * E.g., if two buttons are placed in 'secondary', they'll both appear on the left end (right end in rtl mode)
- * in the order provided.
- *
- * Only 'primary' placement works when legacy call control is enabled in call composite
+ * E.g., if two buttons are placed in 'primary', they'll both appear on the right end (left end in rtl mode)
+ * before the EndCallButton in the order provided.
  *
  * @beta
  */
-declare type CustomCallControlButtonPlacement = 'primary' | 'overflow' | 'secondary';
-export { CustomCallControlButtonPlacement }
-export { CustomCallControlButtonPlacement as CustomCallWithChatControlButtonPlacement }
+export declare type CustomCallControlButtonPlacement = 'primary';
 
 /**
  * Response from {@link CustomCallControlButtonCallback}.
@@ -4510,7 +4472,32 @@ export declare interface CustomCallControlButtonProps extends CustomControlButto
 }
 
 /**
- * Response from {@link CustomCallControlButtonCallback}.
+ * A callback that returns the props to render a custom {@link ControlBarButton} and {@link DrawerMenuItem}.
+ *
+ * The response indicates where the custom button should be placed.
+ *
+ * Performance tip: This callback is only called when either the callback or its arguments change.
+ * @beta
+ */
+export declare type CustomCallWithChatControlButtonCallback = (args: CustomCallControlButtonCallbackArgs) => CustomCallWithChatControlButtonProps;
+
+/**
+ * Placement for a custom button injected in the {@link CallWithChatControlBar}.
+ *
+ * 'primary': Place the button(s) on the right end of the center control bar but before the EndCallButton (left end in rtl mode).
+ * 'overflow': Place the buttons(s) on the end of the overflow Menu.
+ * 'secondary': Place the button(s) on the left end of the side control bar (right in rtl mode).
+ *
+ * Multiple buttons assigned the same placement are appended in order.
+ * E.g., if two buttons are placed in 'secondary', they'll both appear on the left end (right end in rtl mode)
+ * in the order provided.
+ *
+ * @beta
+ */
+export declare type CustomCallWithChatControlButtonPlacement = 'primary' | 'overflow' | 'secondary';
+
+/**
+ * Response from {@link CustomCallWithChatControlButtonCallback}.
  *
  * Includes the icon and placement prop necessary to indicate where to place the
  * {@link ControlBarButton} and a {@link DrawerMenuItem}
@@ -4521,7 +4508,7 @@ export declare interface CustomCallWithChatControlButtonProps extends CustomCont
     /**
      * Where to place the custom button relative to other buttons.
      */
-    placement: CustomCallControlButtonPlacement;
+    placement: CustomCallWithChatControlButtonPlacement;
     /**
      * Icon to render. Icon is a non-default icon name that needs to be registered as a
      * custom icon using registerIcons through fluentui. Examples include icons from the fluentui library
@@ -4627,7 +4614,6 @@ export declare const DEFAULT_COMPONENT_ICONS: {
     ControlButtonScreenShareStop: JSX.Element;
     CancelFileUpload: JSX.Element;
     DownloadFile: JSX.Element;
-    DataLossPreventionProhibited: JSX.Element;
     EditBoxCancel: JSX.Element;
     EditBoxSubmit: JSX.Element;
     ErrorBarCallCameraAccessDenied: JSX.Element;
@@ -4708,7 +4694,6 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     SendBoxSend: JSX.Element;
     SendBoxSendHovered: JSX.Element;
     SendBoxAttachFile?: JSX.Element | undefined;
-    ControlBarPeopleButton?: JSX.Element | undefined;
     ControlButtonCameraOff: JSX.Element;
     ControlButtonCameraOn: JSX.Element;
     ControlButtonEndCall: JSX.Element;
@@ -4755,11 +4740,10 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     PeoplePaneOpenDialpad?: JSX.Element | undefined;
     DialpadStartCall?: JSX.Element | undefined;
     NoticePageInvalidRoom?: JSX.Element | undefined;
-    BlurVideoBackground?: JSX.Element | undefined;
-    RemoveVideoBackgroundEffect?: JSX.Element | undefined;
     ChevronLeft?: JSX.Element | undefined;
     ControlBarChatButtonActive?: JSX.Element | undefined;
     ControlBarChatButtonInactive?: JSX.Element | undefined;
+    ControlBarPeopleButton?: JSX.Element | undefined;
     Link?: JSX.Element | undefined;
     MoreDrawerMicrophones?: JSX.Element | undefined;
     MoreDrawerPeople?: JSX.Element | undefined;
@@ -4770,7 +4754,6 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     ControlButtonParticipantsContextualMenuItem: JSX.Element;
     CancelFileUpload: JSX.Element;
     DownloadFile: JSX.Element;
-    DataLossPreventionProhibited: JSX.Element;
     ErrorBarCallVideoRecoveredBySystem: JSX.Element;
     ErrorBarCallVideoStoppedBySystem: JSX.Element;
     MessageResend: JSX.Element;
@@ -5417,8 +5400,6 @@ export declare type FileDownloadHandler = (userId: string, fileMetadata: FileMet
  * @beta
  */
 export declare interface FileMetadata {
-    attachmentType: FileMetadataAttachmentType;
-    id: string;
     /**
      * File name to be displayed.
      */
@@ -5433,14 +5414,8 @@ export declare interface FileMetadata {
      * Download URL for the file.
      */
     url: string;
-    previewUrl?: string;
 }
 
-/**
- * @beta
- */
-export declare type FileMetadataAttachmentType = 'fileSharing' | /* @conditional-compile-remove(teams-inline-images) */ 'teamsInlineImage' | 'unknown';
-
 /**
  * Properties for configuring the File Sharing feature.
  * @beta
@@ -5484,7 +5459,6 @@ export declare interface FileUploadAdapter {
     updateFileUploadProgress: (id: string, progress: number) => void;
     updateFileUploadErrorMessage: (id: string, errorMessage: string) => void;
     updateFileUploadMetadata: (id: string, metadata: FileMetadata) => void;
-    downloadAuthenticatedAttachment?: (attachmentUrl: string) => Promise<string>;
 }
 
 /**
@@ -6022,7 +5996,7 @@ export declare interface MediaDiagnosticsState {
  *
  * @public
  */
-export declare type Message = ChatMessage | SystemMessage | CustomMessage | /* @conditional-compile-remove(data-loss-prevention) */ BlockedMessage;
+export declare type Message = ChatMessage | SystemMessage | CustomMessage;
 
 /**
  * Indicate whether a chat message should be displayed merged with the message before / after it.
@@ -6059,7 +6033,7 @@ export declare type MessageContentType = 'text' | 'html' | 'richtext/html' | 'un
  */
 export declare type MessageProps = {
     /**
-     * Message to render. It can type `ChatMessage` or `SystemMessage`, `BlockedMessage` or `CustomMessage`.
+     * Message to render. It can type `ChatMessage` or `SystemMessage` or `CustomMessage`.
      */
     message: Message;
     /**
@@ -6234,9 +6208,9 @@ export declare type MessageThreadProps = {
      */
     userId: string;
     /**
-     * Messages to render in message thread. A message can be of type `ChatMessage`, `SystemMessage`, `BlockedMessage` or `CustomMessage`.
+     * Messages to render in message thread. A message can be of type `ChatMessage`, `SystemMessage` or `CustomMessage`.
      */
-    messages: (ChatMessage | SystemMessage | CustomMessage | /* @conditional-compile-remove(data-loss-prevention) */ BlockedMessage)[];
+    messages: (ChatMessage | SystemMessage | CustomMessage)[];
     /**
      * number of participants in the thread
      */
@@ -6443,10 +6417,6 @@ export declare interface MessageThreadStrings {
     actionMenuMoreOptions?: string;
     /** String for download file button in file card */
     downloadFile: string;
-    /** String for policy violation message removal */
-    blockedWarningText: string;
-    /** String for policy violation message removal details link */
-    blockedWarningLinkText: string;
 }
 
 /**
@@ -6473,8 +6443,6 @@ export declare interface MessageThreadStyles extends BaseCustomStyles {
     chatMessageContainer?: ComponentSlotStyle;
     /** Styles for system message container. */
     systemMessageContainer?: ComponentSlotStyle;
-    /** Styles for blocked message container. */
-    blockedMessageContainer?: ComponentSlotStyle;
     /** Styles for message status indicator container. */
     messageStatusContainer?: (mine: boolean) => IStyle;
 }