@azure/communication-react 1.4.2-alpha-202211030017.0 → 1.4.2-alpha-202211050017.0

package/dist/communication-react.d.ts

@@ -1197,9 +1197,11 @@ export declare interface CallCompositeProps extends BaseCompositeProps<CallCompo
      */
     options?: CallCompositeOptions;
     /**
-     * Set this to enable/disable capacities for different roles
+     * Set the role to enable/disable capacities. This property should be properly set for Rooms calls. The role of a
+     * user for a room can be obtained using the Rooms API. The role of the user will be synced with ACS services when
+     * a Rooms call starts.
      */
-    role?: Role;
+    roleHint?: Role;
 }
 
 /**
@@ -1638,7 +1640,7 @@ export declare type CallErrors = {
  *
  * @public
  */
-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';
+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) */ /* @conditional-compile-remove(teams-identity-support) */ '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' | /* @conditional-compile-remove(calling-beta-sdk) */ /* @conditional-compile-remove(teams-identity-support) */ 'TeamsCall.addParticipant';
 
 /**
  * Callback for {@link CallAdapterSubscribers} 'callIdChanged' event.
@@ -1777,6 +1779,10 @@ export declare interface CallState {
      * Proxy of {@link @azure/communication-calling#Call.id}.
      */
     id: string;
+    /**
+     * Type of the call.
+     */
+    type: 'Teams' | 'ACS';
     /**
      * Proxy of {@link @azure/communication-calling#Call.callerInfo}.
      */
@@ -2645,6 +2651,35 @@ export declare interface CallWithChatControlOptions {
  */
 export declare type CallWithChatEvent = 'callError' | 'chatError' | 'callEnded' | 'isMutedChanged' | 'callIdChanged' | 'isLocalScreenSharingActiveChanged' | 'displayNameChanged' | 'isSpeakingChanged' | 'callParticipantsJoined' | 'callParticipantsLeft' | 'selectedMicrophoneChanged' | 'selectedSpeakerChanged' | 'messageReceived' | 'messageSent' | 'messageRead' | 'chatParticipantsAdded' | 'chatParticipantsRemoved';
 
+/**
+ * @beta
+ *
+ * Component to allow Contoso to help their end user with their devices should their permissions be blocked
+ * by their browsers settings.
+ */
+export declare const CameraAndMicrophoneDomainPermissions: (props: CameraAndMicrophoneDomainPermissionsProps) => JSX.Element;
+
+/**
+ * @beta
+ * Props for CameraAndMicrophoneDomainPermissions component.
+ */
+export declare interface CameraAndMicrophoneDomainPermissionsProps extends CommonDomainPermissionsProps {
+    /** Icon name for the camera icon */
+    cameraIconName?: string;
+    /** Icon name for the microphone icon */
+    microphoneIconName?: string;
+    /** Icon name for the central icon between the camera and microphone icons */
+    connectorIconName?: string;
+    /** Strings for use with the {@link CameraAndMicrophoneDomainPermissions} */
+    strings?: CameraAndMicrophoneDomainPermissionsStrings;
+}
+
+/**
+ * @beta
+ * Strings for CameraAndMicrophoneDomainPermissions component.
+ */
+export declare type CameraAndMicrophoneDomainPermissionsStrings = DomainPermissionsStrings;
+
 /**
  * A button to turn camera on / off.
  *
@@ -2781,6 +2816,31 @@ export declare interface CameraButtonStyles extends ControlBarButtonStyles {
     menuStyles?: Partial<CameraButtonContextualMenuStyles>;
 }
 
+/**
+ * Component to allow Contoso to help their end user with their devices should their permissions be blocked
+ * by their browsers settings.
+ *
+ * @beta
+ */
+export declare const CameraDomainPermissions: (props: CameraDomainPermissionsProps) => JSX.Element;
+
+/**
+ * @beta
+ * Props for CameraDomainPermissions component.
+ */
+export declare interface CameraDomainPermissionsProps extends CommonDomainPermissionsProps {
+    /** Icon name for the camera icon */
+    cameraIconName?: string;
+    /** Strings for use with the {@link CameraDomainPermissions} */
+    strings?: CameraDomainPermissionsStrings;
+}
+
+/**
+ * @beta
+ * Strings for CameraDomainPermissions component.
+ */
+export declare type CameraDomainPermissionsStrings = DomainPermissionsStrings;
+
 /**
  * {@link ChatComposite} Adapter interface.
  *
@@ -3339,6 +3399,35 @@ export declare type ClientState = CallClientState & ChatClientState;
  */
 export declare type Common<A, B> = Pick<A, CommonProperties<A, B>>;
 
+/**
+ * @beta
+ * Props for DomainPermissions components.
+ */
+export declare interface CommonDomainPermissionsProps {
+    /**
+     * Name of application calling experience is in.
+     */
+    appName: string;
+    /**
+     * Type of the Domain Permissions component.
+     */
+    type: 'request' | 'denied' | 'check';
+    /**
+     * Action to be taken by the more help link. Possible to send to external page or show other modal.
+     * If this is not provided the button will not be shown.
+     */
+    onTroubleshootingClick?: () => void;
+    /**
+     * Action that is taken when the user clicks the continue anyway button.
+     * If this is not provided the button will not be shown.
+     */
+    onContinueAnywayClick?: () => void;
+    /**
+     * Styles for DomainPermissions component.
+     */
+    styles?: DomainPermissionsStyles;
+}
+
 /**
  * Return intersect properties of 2 types
  *
@@ -3527,8 +3616,24 @@ export declare interface ComponentStrings {
     videoTile: VideoTileStrings;
     /** Strings for HoldButton */
     holdButton: HoldButtonStrings;
-    /** Strings for DomainPermissions */
-    DomainPermissions: DomainPermissionsStrings;
+    /** Strings for a domain permission request prompt */
+    CameraAndMicrophoneDomainPermissionsRequest: DomainPermissionsStrings;
+    /** Strings for a domain permission request prompt */
+    CameraDomainPermissionsRequest: DomainPermissionsStrings;
+    /** Strings for a domain permission request prompt */
+    MicrophoneDomainPermissionsRequest: DomainPermissionsStrings;
+    /** Strings for a domain permission generic checking prompt */
+    CameraAndMicrophoneDomainPermissionsCheck: DomainPermissionsStrings;
+    /** Strings for a domain permission generic checking prompt */
+    CameraDomainPermissionsCheck: DomainPermissionsStrings;
+    /** Strings for a domain permission generic checking prompt */
+    MicrophoneDomainPermissionsCheck: DomainPermissionsStrings;
+    /** Strings for a domain permission denied prompt */
+    CameraAndMicrophoneDomainPermissionsDenied: DomainPermissionsStrings;
+    /** Strings for a domain permission denied prompt */
+    CameraDomainPermissionsDenied: DomainPermissionsStrings;
+    /** Strings for a domain permission denied prompt */
+    MicrophoneDomainPermissionsDenied: DomainPermissionsStrings;
     /** Strings for unsupported browser UI */
     UnsupportedBrowser: UnsupportedBrowserStrings;
     /** Strings for BrowserPemissionDenied */
@@ -4161,20 +4266,10 @@ export declare interface CustomMessage extends MessageCommon {
 export declare const darkTheme: PartialTheme & CallingTheme;
 
 /**
- * @public
+ * @beta
  * `DeclarativeCallAgent` extends and proxies the {@link @azure/communication-calling#CallAgent}
  */
-export declare type DeclarativeCallAgent = CallAgent & /* @conditional-compile-remove(one-to-n-calling) */ {
-    /**
-     * @beta
-     * A readonly array that returns all the active `incomingCalls`.
-     * An active incoming call is a call that has not been answered, declined or disconnected.
-     *
-     * @Remark This attribute doesn't exist on the {@link @azure/communication-calling#CallAgent} interface.
-     * @returns readonly array of {@link DeclarativeIncomingCall}
-     */
-    incomingCalls: ReadonlyArray<DeclarativeIncomingCall>;
-};
+export declare type DeclarativeCallAgent = CallAgent & IncomingCallManagement;
 
 /**
  * @beta
@@ -4245,6 +4340,8 @@ export declare const DEFAULT_COMPONENT_ICONS: {
     DomainPermissionsSparkle: JSX.Element;
     DomainPermissionCamera: JSX.Element;
     DomainPermissionMic: JSX.Element;
+    DomainPermissionCameraDenied: JSX.Element;
+    DomainPermissionMicDenied: JSX.Element;
     UnsupportedBrowserWarning: JSX.Element;
     BrowserPermissionDeniedError: JSX.Element;
 };
@@ -4338,6 +4435,8 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     DomainPermissionsSparkle: JSX.Element;
     DomainPermissionCamera: JSX.Element;
     DomainPermissionMic: JSX.Element;
+    DomainPermissionCameraDenied: JSX.Element;
+    DomainPermissionMicDenied: JSX.Element;
     UnsupportedBrowserWarning: JSX.Element;
     BrowserPermissionDeniedError: JSX.Element;
 };
@@ -4723,62 +4822,43 @@ export declare interface Disposable {
     dispose(): void;
 }
 
-/**
- * @beta
- *
- * Component to allow Contoso to help their end user with their devices should their permissions be blocked
- * by their browsers settings.
- */
-export declare const DomainPermissions: (props: DomainPermissionsProps) => JSX.Element;
-
-/**
- * @beta
- * Props for DomainPermissions component.
- */
-export declare interface DomainPermissionsProps {
-    /**
-     * Name of application calling experience is in.
-     */
-    appName: string;
-    /**
-     * Action to be taken by the more help link. Possible to send to external page or show other modal.
-     */
-    onTroubleshootingClick?: () => void;
-    /**
-     * Action to be taken by the Allow Access button.
-     */
-    onAllowAccessClick?: () => void;
-    /**
-     * Localization strings for DomainPermissions component.
-     */
-    strings?: DomainPermissionsStrings;
-}
-
 /**
  * @beta
  * Strings for DomainPermissions component
  */
-export declare interface DomainPermissionsStrings {
+export declare type DomainPermissionsStrings = {
     /**
      * Main text string.
      */
-    primaryText: string;
+    primaryText?: string;
     /**
      * Subtext string.
      */
-    secondaryText: string;
+    secondaryText?: string;
     /**
      * More help link string.
      */
-    linkText: string;
+    linkText?: string;
     /**
      * Primary button text string.
      */
-    primaryButtonText: string;
+    primaryButtonText?: string;
     /**
-     * Aira label describing the content of the container
+     * Aria label describing the content of the container
      */
-    ariaLabel: string;
+    ariaLabel?: string;
+};
+
+/**
+ * Fluent styles for {@link DomainPermissionsContainer}.
+ *
+ * @beta
+ */
+export declare interface DomainPermissionsStyles extends BaseCustomStyles {
+    /** Styles for the primary button. */
+    primaryButton?: IButtonStyles;
+    /** Styles for the help troubleshooting link text. */
+    troubleshootingLink?: ILinkStyles;
 }
 
 /**
@@ -5442,6 +5522,20 @@ export declare interface _Identifiers {
     horizontalGalleryRightNavButton: string;
 }
 
+/**
+ * @beta
+ * This contains a readonly array that returns all the active `incomingCalls`.
+ * An active incoming call is a call that has not been answered, declined or disconnected.
+ */
+export declare type IncomingCallManagement = {
+    /**
+     * @beta
+     * @Remark This attribute doesn't exist on the {@link @azure/communication-calling#CallAgent} interface.
+     * @returns readonly array of {@link DeclarativeIncomingCall}
+     */
+    incomingCalls: ReadonlyArray<DeclarativeIncomingCall>;
+};
+
 /**
  * State only version of {@link @azure/communication-calling#IncomingCall}. {@link StatefulCallClient} will
  * automatically detect incoming calls and add their state to the state exposed by {@link StatefulCallClient}.
@@ -6215,6 +6309,31 @@ export declare interface MicrophoneButtonStyles extends ControlBarButtonStyles {
     menuStyles?: Partial<MicrophoneButtonContextualMenuStyles>;
 }
 
+/**
+ * Component to allow Contoso to help their end user with their devices should their permissions be blocked
+ * by their browsers settings.
+ *
+ * @beta
+ */
+export declare const MicrophoneDomainPermissions: (props: MicrophoneDomainPermissionsProps) => JSX.Element;
+
+/**
+ * @beta
+ * Props for MicrophoneDomainPermissions component.
+ */
+export declare interface MicrophoneDomainPermissionsProps extends CommonDomainPermissionsProps {
+    /** Icon name for the microphone icon */
+    microphoneIconName?: string;
+    /** Strings for use with the {@link MicrophoneDomainPermissions} */
+    strings?: MicrophoneDomainPermissionsStrings;
+}
+
+/**
+ * @beta
+ * Strings for MicrophoneDomainPermissions component.
+ */
+export declare type MicrophoneDomainPermissionsStrings = DomainPermissionsStrings;
+
 /**
  * Payload for {@link DiagnosticChangedEventListner} where there is a change in a network diagnostic.
  *