@azure/communication-react 1.3.3-alpha-202209220018.0 → 1.3.3-alpha-202210070024.0

package/dist/communication-react.d.ts

@@ -50,6 +50,9 @@ import { IButtonStyles } from '@fluentui/react';
 import { IContextualMenuItem } from '@fluentui/react';
 import { IContextualMenuItemStyles } from '@fluentui/react';
 import { IContextualMenuStyles } from '@fluentui/react';
+import { IDropdownOption } from '@fluentui/react';
+import { IDropdownStyles } from '@fluentui/react';
+import { ILinkStyles } from '@fluentui/react';
 import { IMessageBarProps } from '@fluentui/react';
 import { IncomingCall } from '@azure/communication-calling';
 import { IPersonaStyleProps } from '@fluentui/react';
@@ -184,13 +187,6 @@ export declare interface AdapterState<TState> {
     getState(): TState;
 }
 
-/**
- * handler type for addParticipant
- *
- * @beta
- */
-export declare type AddParticipantHandler = ((participant: CommunicationUserIdentifier) => Promise<void>) & ((participant: PhoneNumberIdentifier, options: AddPhoneNumberOptions) => Promise<void>);
-
 /**
  * Compare if 2 react components are exact equal, result type will be true/false
  *
@@ -360,6 +356,136 @@ export declare interface BaseCustomStyles {
     root?: IStyle;
 }
 
+/**
+ * @beta
+ * Props for BrowserPermissionDeniedIOS component.
+ */
+export declare interface BrowserPermissionDeniedIOSProps extends BrowserPermissionDeniedProps {
+    /**
+     * Localization strings for BrowserPermissionDeniedIOS component.
+     */
+    strings: BrowserPermissionDeniedIOSStrings;
+    /**
+     * Link to image source.
+     *
+     * Image is inserted into the top of the component.
+     */
+    imageSource?: string;
+}
+
+/**
+ * @beta
+ * Strings for BrowserPermissionDeniedIOS component
+ */
+export declare interface BrowserPermissionDeniedIOSStrings extends BrowserPermissionDeniedStrings {
+    /**
+     * Image alt text
+     */
+    imageAltText: string;
+    /**
+     * Main text string.
+     */
+    primaryText: string;
+    /**
+     * Subtext string.
+     */
+    secondaryText: string;
+    /**
+     * Step 1 string
+     */
+    step1Text: string;
+    /**
+     * Step 1 digit string
+     */
+    step1DigitText: string;
+    /**
+     * Step 2 string
+     */
+    step2Text: string;
+    /**
+     * Step 2 digit string
+     */
+    step2DigitText: string;
+    /**
+     * Step 3 string
+     */
+    step3Text: string;
+    /**
+     * Step 3 digit string
+     */
+    step3DigitText: string;
+    /**
+     * Step 4 string
+     */
+    step4Text: string;
+    /**
+     * Step 4 digit string
+     */
+    step4DigitText: string;
+}
+
+/**
+ * @beta
+ * Props for BrowserPermissionDenied component.
+ */
+export declare interface BrowserPermissionDeniedProps {
+    /**
+     * 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 try again primary button.
+     */
+    onTryAgainClick: () => void;
+    /**
+     * Localization strings for BrowserPermissionDenied component.
+     */
+    strings: BrowserPermissionDeniedStrings;
+    /**
+     * Allows users to pass in an object contains custom CSS styles.
+     * @Example
+     * ```
+     * <BrowserPermissionDenied styles={{ primaryButton: { root: {backgroundColor: 'blue' }}}} />
+     * ```
+     */
+    styles?: BrowserPermissionDeniedStyles;
+}
+
+/**
+ * @beta
+ * Strings for BrowserPermissionDenied component
+ */
+export declare interface BrowserPermissionDeniedStrings {
+    /**
+     * Main button text string.
+     */
+    primaryButtonText: string;
+    /**
+     * Main text string.
+     */
+    primaryText: string;
+    /**
+     * Subtext string.
+     */
+    secondaryText: string;
+    /**
+     * More help link string.
+     */
+    linkText: string;
+}
+
+/**
+ * Fluent styles for {@link BrowserPermissionDenied}.
+ *
+ * @beta
+ */
+export declare interface BrowserPermissionDeniedStyles extends BaseCustomStyles {
+    /** Styles for the primary button. */
+    primaryButton?: IButtonStyles;
+    /** Styles for the help troubleshooting link text. */
+    troubleshootingLink?: ILinkStyles;
+}
+
 /**
  * {@link CallComposite} Adapter interface.
  *
@@ -375,7 +501,6 @@ export declare interface CallAdapter extends AdapterState<CallAdapterState>, Dis
  */
 export declare type CallAdapterCallEndedEvent = {
     callId?: string;
-    callEndReason?: CallEndReason;
 };
 
 /**
@@ -436,6 +561,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.
      *
@@ -456,6 +587,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.
      *
@@ -1330,6 +1467,14 @@ export declare interface CallCompositeStrings {
      * 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;
 }
 
 /**
@@ -1470,7 +1615,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.
@@ -1511,13 +1656,16 @@ export declare type CallingHandlers = {
     onToggleScreenShare: () => Promise<void>;
     onHangUp: () => Promise<void>;
     onToggleHold: () => Promise<void>;
-    onAddParticipant: AddParticipantHandler;
+    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>;
+    askDevicePermission: (constrain: PermissionConstraints) => Promise<void>;
 };
 
 /**
@@ -1709,6 +1857,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.
      *
@@ -1763,6 +1917,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.
      *
@@ -3337,6 +3497,10 @@ export declare interface ComponentStrings {
     DomainPermissions: DomainPermissionsStrings;
     /** Strings for unsupported browser UI */
     UnsupportedBrowser: UnsupportedBrowserStrings;
+    /** Strings for BrowserPemissionDenied */
+    BrowserPermissionDenied: BrowserPermissionDeniedStrings;
+    /** Strings for BrowserPemissionDeniedIOS */
+    BrowserPermissionDeniedIOS: BrowserPermissionDeniedIOSStrings;
 }
 
 /**
@@ -4048,6 +4212,7 @@ export declare const DEFAULT_COMPONENT_ICONS: {
     DomainPermissionCamera: JSX.Element;
     DomainPermissionMic: JSX.Element;
     UnsupportedBrowserWarning: JSX.Element;
+    BrowserPermissionDeniedError: JSX.Element;
 };
 
 /**
@@ -4140,6 +4305,7 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     DomainPermissionCamera: JSX.Element;
     DomainPermissionMic: JSX.Element;
     UnsupportedBrowserWarning: JSX.Element;
+    BrowserPermissionDeniedError: JSX.Element;
 };
 
 /**
@@ -4197,6 +4363,68 @@ export declare type DeviceManagerState = {
     unparentedViews: LocalVideoStreamState[];
 };
 
+/**
+ * A dropdown to trigger device permission prompt
+ *
+ * @internal
+ */
+export declare const _DevicePermissionDropdown: (props: _DevicePermissionDropdownProps) => JSX.Element;
+
+/**
+ * Props for {@link _DevicePermissionDropdown}.
+ *
+ * @internal
+ */
+export declare interface _DevicePermissionDropdownProps {
+    /**
+     * icon shown in dropdown placeholder
+     */
+    icon?: JSX.Element;
+    /**
+     * Dropdown content
+     */
+    options?: IDropdownOption[];
+    /**
+     * Ask for permissions of devices.
+     *
+     * @remarks
+     * Browser permission window will pop up if permissions are not granted yet
+     *
+     * @param constrain - Define constraints for accessing local devices {@link @azure/communication-calling#PermissionConstraints }
+     */
+    askDevicePermission?(constrain: _PermissionConstraints): Promise<void>;
+    /**
+     * Define constraints for accessing local devices  {@link @azure/communication-calling#PermissionConstraints }
+     */
+    constrain?: _PermissionConstraints;
+    /**
+     * Strings for devicepermissiondropdown
+     */
+    strings?: _DevicePermissionDropdownStrings;
+    /**
+     * Styles for devicepermissiondropdown
+     */
+    styles?: Partial<IDropdownStyles>;
+}
+
+/**
+ * Strings of {@link DevicePermissionDropdown} that can be overridden.
+ *
+ * @internal
+ */
+export declare interface _DevicePermissionDropdownStrings {
+    /**
+     * dropdown label
+     */
+    label?: string;
+    /**
+     * dropdown placeholder
+     */
+    placeHolderText: string;
+    /** string for action button  */
+    actionButtonContent?: string;
+}
+
 /**
  * Device Permission restrictions.
  * Be able to start a call depending on camera and microphone permission options.
@@ -4478,6 +4706,10 @@ export declare interface DomainPermissionsProps {
      * 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.
      */
@@ -4501,6 +4733,10 @@ export declare interface DomainPermissionsStrings {
      * More help link string.
      */
     linkText: string;
+    /**
+     * Primary button text string.
+     */
+    primaryButtonText: string;
 }
 
 /**
@@ -4965,7 +5201,7 @@ export declare const fromFlatCommunicationIdentifier: (id: string) => Communicat
  *
  * @public
  */
-export declare type GetCallingSelector<Component extends (props: any) => JSX.Element | undefined> = AreEqual<Component, typeof VideoGallery> extends true ? VideoGallerySelector : AreEqual<Component, typeof DevicesButton> extends true ? DevicesButtonSelector : AreEqual<Component, typeof MicrophoneButton> extends true ? MicrophoneButtonSelector : AreEqual<Component, typeof CameraButton> extends true ? CameraButtonSelector : AreEqual<Component, typeof ScreenShareButton> extends true ? ScreenShareButtonSelector : AreEqual<Component, typeof ParticipantList> extends true ? ParticipantListSelector : AreEqual<Component, typeof ParticipantsButton> extends true ? ParticipantsButtonSelector : AreEqual<Component, typeof EndCallButton> extends true ? EmptySelector : AreEqual<Component, typeof ErrorBar> extends true ? CallErrorBarSelector : AreEqual<Component, typeof Dialpad> extends true ? EmptySelector : AreEqual<Component, typeof HoldButton> extends true ? HoldButtonSelector : undefined;
+export declare type GetCallingSelector<Component extends (props: any) => JSX.Element | undefined> = AreEqual<Component, typeof VideoGallery> extends true ? VideoGallerySelector : AreEqual<Component, typeof DevicesButton> extends true ? DevicesButtonSelector : AreEqual<Component, typeof MicrophoneButton> extends true ? MicrophoneButtonSelector : AreEqual<Component, typeof CameraButton> extends true ? CameraButtonSelector : AreEqual<Component, typeof ScreenShareButton> extends true ? ScreenShareButtonSelector : AreEqual<Component, typeof ParticipantList> extends true ? ParticipantListSelector : AreEqual<Component, typeof ParticipantsButton> extends true ? ParticipantsButtonSelector : AreEqual<Component, typeof EndCallButton> extends true ? EmptySelector : AreEqual<Component, typeof ErrorBar> extends true ? CallErrorBarSelector : AreEqual<Component, typeof Dialpad> extends true ? EmptySelector : AreEqual<Component, typeof HoldButton> extends true ? HoldButtonSelector : AreEqual<Component, typeof _DevicePermissionDropdown> extends true ? EmptySelector : undefined;
 
 /**
  * Get the selector for a specified component.
@@ -6379,6 +6615,16 @@ export declare type ParticipantsRemovedListener = (event: {
  */
 export declare type ParticipantState = 'Idle' | 'Connecting' | 'Ringing' | 'Connected' | 'Hold' | 'InLobby' | 'EarlyMedia' | 'Disconnected';
 
+/**
+ * Define constraints for accessing local devices  {@link @azure/communication-calling#PermissionConstraints }
+ *
+ * @internal
+ */
+export declare type _PermissionConstraints = {
+    audio: boolean;
+    video: boolean;
+};
+
 /**
  * An array of key value pairs that stores each sender's display name and last read message
  *