@azure/communication-react 1.7.0-alpha-202307250014 → 1.7.0-alpha-202307261914

package/dist/communication-react.d.ts

@@ -616,23 +616,23 @@ export declare interface BrowserPermissionDeniedStyles extends BaseCustomStyles
 export declare interface CallAdapter extends CommonCallAdapter {
     /**
      * Join the call with microphone initially on/off.
-     *
+     * @deprecated Use joinCall(options?:JoinCallOptions) instead.
      * @param microphoneOn - Whether microphone is initially enabled
      *
      * @public
      */
     joinCall(microphoneOn?: boolean): Call | undefined;
     /**
-     * Join the call with options bag to set microphone/camera initially on/off.
+     * Join the call with options bag to set microphone/camera initial state when joining call
+     * true = turn on the device when joining call
+     * false = turn off the device when joining call
+     * 'keep'/undefined = retain devices' precall state
      *
-     * @param options - param to set microphone/camera initially on/off.
+     * @param options - param to set microphone/camera initially on/off/use precall state.
      *
      * @public
      */
-    joinCallWithOptions(options?: {
-        microphoneOn?: boolean;
-        cameraOn?: boolean;
-    }): Call | undefined;
+    joinCall(options?: JoinCallOptions): Call | undefined;
     /**
      * Start the call.
      *
@@ -666,23 +666,23 @@ export declare type CallAdapterCallEndedEvent = {
 export declare interface CallAdapterCallManagement extends CallAdapterCallOperations {
     /**
      * Join the call with microphone initially on/off.
-     *
+     * @deprecated Use joinCall(options?:JoinCallOptions) instead.
      * @param microphoneOn - Whether microphone is initially enabled
      *
      * @public
      */
     joinCall(microphoneOn?: boolean): Call | undefined;
     /**
-     * Join the call with options bag to set microphone/camera initially on/off.
+     * Join the call with options bag to set microphone/camera initial state when joining call
+     * true = turn on the device when joining call
+     * false = turn off the device when joining call
+     * 'keep'/undefined = retain devices' precall state
      *
-     * @param options - param to set microphone/camera initially on/off.
+     * @param options - param to set microphone/camera initially on/off/use precall state.
      *
      * @public
      */
-    joinCallWithOptions(options?: {
-        microphoneOn?: boolean;
-        cameraOn?: boolean;
-    }): Call | undefined;
+    joinCall(options?: JoinCallOptions): Call | undefined;
     /**
      * Start the call.
      *
@@ -2367,23 +2367,23 @@ export declare interface CallWithChatAdapterManagement {
     removeParticipant(participant: CommunicationIdentifier): Promise<void>;
     /**
      * Join the call with microphone initially on/off.
-     *
+     * @deprecated Use joinCall(options?:JoinCallOptions) instead.
      * @param microphoneOn - Whether microphone is initially enabled
      *
      * @public
      */
     joinCall(microphoneOn?: boolean): Call | undefined;
     /**
-     * Join the call with options bag to set microphone/camera initially on/off.
+     * Join the call with options bag to set microphone/camera initial state when joining call
+     * true = turn on the device when joining call
+     * false = turn off the device when joining call
+     * 'keep'/undefined = retain devices' precall state
      *
-     * @param options - param to set microphone/camera initially on/off.
+     * @param options - param to set microphone/camera initially on/off/use precall state.
      *
      * @public
      */
-    joinCallWithOptions(options?: {
-        microphoneOn?: boolean;
-        cameraOn?: boolean;
-    }): Call | undefined;
+    joinCall(options?: JoinCallOptions): Call | undefined;
     /**
      * Leave the call.
      *
@@ -4119,23 +4119,23 @@ export declare type Common<A, B> = Pick<A, CommonProperties<A, B>>;
 export declare interface CommonCallAdapter extends AdapterState<CallAdapterState>, Disposable, CallAdapterCallOperations, CallAdapterDeviceManagement, CallAdapterSubscribers {
     /**
      * Join the call with microphone initially on/off.
-     *
+     * @deprecated Use joinCall(options?:JoinCallOptions) instead.
      * @param microphoneOn - Whether microphone is initially enabled
      *
      * @public
      */
     joinCall(microphoneOn?: boolean): void;
     /**
-     * Join the call with options bag to set microphone/camera initially on/off.
+     * Join the call with options bag to set microphone/camera initial state when joining call
+     * true = turn on the device when joining call
+     * false = turn off the device when joining call
+     * 'keep'/undefined = retain devices' precall state
      *
-     * @param options - param to set microphone/camera initially on/off.
+     * @param options - param to set microphone/camera initially on/off/use precall state.
      *
      * @public
      */
-    joinCallWithOptions(options?: {
-        microphoneOn?: boolean;
-        cameraOn?: boolean;
-    }): void;
+    joinCall(options?: JoinCallOptions): void;
     /**
      * Start the call.
      *
@@ -4612,6 +4612,8 @@ export declare interface ComponentStrings {
      * Strings for the VerticalGallery.
      */
     VerticalGallery: VerticalGalleryStrings;
+    /** Strings for the participant list component */
+    ParticipantList: ParticipantListStrings;
 }
 
 /**
@@ -6632,6 +6634,31 @@ export declare type IsSpeakingChangedListener = (event: {
     isSpeaking: boolean;
 }) => void;
 
+/**
+ * Options for setting microphone and camera state when joining a call
+ * true = turn on the device when joining call
+ * false = turn off the device when joining call
+ * 'keep'/undefined = retain devices' precall state
+ *
+ * @public
+ */
+export declare interface JoinCallOptions {
+    /**
+     * microphone state when joining call
+     * true: turn on
+     * false: turn off
+     * 'keep': maintain precall state
+     */
+    microphoneOn?: boolean | 'keep';
+    /**
+     * camera state when joining call
+     * true: turn on
+     * false: turn off
+     * 'keep': maintain precall state
+     */
+    cameraOn?: boolean | 'keep';
+}
+
 /**
  * Arguments for {@link MessageThreadProps.onRenderJumpToNewMessageButton}.
  *
@@ -7774,6 +7801,10 @@ export declare type ParticipantListProps = {
     styles?: ParticipantListStyles;
     /** Optional value to determine if the tooltip should be shown for participants or not */
     showParticipantOverflowTooltip?: boolean;
+    /** Total number of people in the call. This number can be larger than the remote participant count. */
+    totalParticipantCount?: number;
+    /** Strings for the participant list */
+    strings?: ParticipantListStrings;
     /** Optional aria-lablledby prop that prefixes each ParticipantItem aria-label */
     participantAriaLabelledBy?: string;
 };
@@ -7786,8 +7817,21 @@ export declare type ParticipantListProps = {
 export declare type ParticipantListSelector = (state: CallClientState, props: CallingBaseSelectorProps) => {
     participants: CallParticipantListParticipant[];
     myUserId: string;
+    totalParticipantCount?: number;
 };
 
+/**
+ * Strings for the {@link ParticipantList}.
+ *
+ * @beta
+ */
+export declare interface ParticipantListStrings {
+    /**
+     * String for rendering the count of participants not contained in the displayed participant list
+     */
+    overflowParticipantCount?: string;
+}
+
 /**
  * Styles for the {@link ParticipantList}.
  *
@@ -8706,23 +8750,23 @@ export declare type TeamsAdapterOptions = CommonCallAdapterOptions;
 export declare interface TeamsCallAdapter extends CommonCallAdapter {
     /**
      * Join the call with microphone initially on/off.
-     *
+     * @deprecated Use joinCall(options?:JoinCallOptions) instead.
      * @param microphoneOn - Whether microphone is initially enabled
      *
      * @beta
      */
     joinCall(microphoneOn?: boolean): TeamsCall | undefined;
     /**
-     * Join the call with options bag to set microphone/camera initially on/off.
+     * Join the call with options bag to set microphone/camera initial state when joining call
+     * true = turn on the device when joining call
+     * false = turn off the device when joining call
+     * 'keep'/undefined = retain devices' precall state
      *
      * @param options - param to set microphone/camera initially on/off.
      *
      * @public
      */
-    joinCallWithOptions(options?: {
-        microphoneOn?: boolean;
-        cameraOn?: boolean;
-    }): TeamsCall | undefined;
+    joinCall(options?: JoinCallOptions): TeamsCall | undefined;
     /**
      * Start the call.
      *