@azure/communication-react 1.3.3-alpha-202209210019.0 → 1.3.3-alpha-202210060021.0

package/dist/communication-react.d.ts

@@ -50,6 +50,8 @@ 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 { IMessageBarProps } from '@fluentui/react';
 import { IncomingCall } from '@azure/communication-calling';
 import { IPersonaStyleProps } from '@fluentui/react';
@@ -184,13 +186,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
  *
@@ -375,7 +370,6 @@ export declare interface CallAdapter extends AdapterState<CallAdapterState>, Dis
  */
 export declare type CallAdapterCallEndedEvent = {
     callId?: string;
-    callEndReason?: CallEndReason;
 };
 
 /**
@@ -436,6 +430,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 +456,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.
      *
@@ -969,6 +975,11 @@ export declare type CallCompositeOptions = {
      * @defaultValue true
      */
     callControls?: boolean | CallControlOptions;
+    /**
+     * Device permission restrictions for your call.
+     * Require device permissions to be set or have them as optional or not required to start a call
+     */
+    devicePermissions?: DevicePermissionRestrictions;
     /**
      * Callback you may provide to supply users with further steps to troubleshoot why they have been
      * unable to grant your site the required permissions for the call.
@@ -1325,6 +1336,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;
 }
 
 /**
@@ -1465,7 +1484,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.
@@ -1506,10 +1525,12 @@ 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>;
@@ -1704,6 +1725,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.
      *
@@ -1758,6 +1785,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.
      *
@@ -2154,6 +2187,11 @@ export declare type CallWithChatCompositeOptions = {
      * @beta
      */
     fileSharing?: FileSharingOptions;
+    /**
+     * Device permission restrictions for your call.
+     * Require device permissions to be set or have them as optional or not required to start a call
+     */
+    devicePermissions?: DevicePermissionRestrictions;
     /**
      * Callback you may provide to supply users with further steps to troubleshoot why they have been
      * unable to grant your site the required permissions for the call.
@@ -4034,7 +4072,9 @@ export declare const DEFAULT_COMPONENT_ICONS: {
     SendBoxSendHovered: JSX.Element;
     VideoTileMicOff: JSX.Element;
     BackSpace: JSX.Element;
-    iconBackdrop: JSX.Element;
+    DomainPermissionsSparkle: JSX.Element;
+    DomainPermissionCamera: JSX.Element;
+    DomainPermissionMic: JSX.Element;
     UnsupportedBrowserWarning: JSX.Element;
 };
 
@@ -4124,7 +4164,9 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     HoldCallButton: JSX.Element;
     ResumeCall: JSX.Element;
     BackSpace: JSX.Element;
-    iconBackdrop: JSX.Element;
+    DomainPermissionsSparkle: JSX.Element;
+    DomainPermissionCamera: JSX.Element;
+    DomainPermissionMic: JSX.Element;
     UnsupportedBrowserWarning: JSX.Element;
 };
 
@@ -4183,6 +4225,82 @@ 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[];
+    /**
+     * Function that gets triggered when action button is clicked
+     */
+    onClickActionButton?: () => Promise<void>;
+    /**
+     * 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.
+ *
+ * @beta
+ */
+export declare interface DevicePermissionRestrictions {
+    /**
+     * Camera Permission prompts for your call.
+     * 'required' - requires the permission to be allowed before permitting the user join the call.
+     * 'optional' - permission can be disallowed and the user is still permitted to join the call.
+     * 'doNotPrompt' - permission is not required and the user is not prompted to allow the permission.
+     */
+    camera: 'required' | 'optional' | 'doNotPrompt';
+    /**
+     * Microphone permission prompts for your call.
+     * 'required' - requires the permission to be allowed before permitting the user join the call.
+     * 'optional' - permission can be disallowed and the user is still permitted to join the call.
+     * 'doNotPrompt' - permission is not required and the user is not prompted to allow the permission.
+     */
+    microphone: 'required' | 'optional' | 'doNotPrompt';
+}
+
 /**
  * A button to open a menu that controls device options.
  *