@azure/communication-react 1.3.2-alpha-202208060014.0 → 1.3.2-alpha-202208110020.0

package/dist/communication-react.d.ts

@@ -1423,7 +1423,7 @@ export declare interface CallingTheme {
  */
 export declare type CallParticipantListParticipant = ParticipantListParticipant & {
     /** State of calling participant */
-    state: 'Idle' | 'Connecting' | 'Ringing' | 'Connected' | 'Hold' | 'InLobby' | 'EarlyMedia' | 'Disconnected';
+    state: ParticipantState;
     /** Whether calling participant is screen sharing */
     isScreenSharing?: boolean;
     /** Whether calling participant is muted */
@@ -1924,6 +1924,8 @@ export declare interface CallWithChatClientState {
     devices: DeviceManagerState;
     /** State of whether the active call is a Teams interop call */
     isTeamsCall: boolean;
+    /** alternateCallerId for PSTN call */
+    alternateCallerId?: string | undefined;
 }
 
 /**
@@ -3584,6 +3586,8 @@ export declare type CustomAvatarOptions = {
     styles?: IStyleFunctionOrObject<IPersonaStyleProps, IPersonaStyles>;
     /** Display name to be used in Persona  */
     text?: string;
+    /** State for the participant to be displayed in the defaultPlaceHolder */
+    participantState?: ParticipantState;
 };
 
 /**
@@ -5741,6 +5745,14 @@ export declare interface ParticipantItemProps {
     onClick?: (props?: ParticipantItemProps) => void;
     /** prop to determine if we should show tooltip for participants or not */
     showParticipantOverflowTooltip?: boolean;
+    /**
+     * Optional value to determine and display a participants connection status.
+     * For example, `Connecting`, `Ringing` etc.
+     * The actual text that is displayed is determined by the localized string
+     * corresponding to the provided participant state.
+     * For example, `strings.participantStateConnecting` will be used if `participantState` is `Connecting`.
+     */
+    participantState?: ParticipantState;
 }
 
 /**
@@ -5761,6 +5773,12 @@ export declare interface ParticipantItemStrings {
     mutedIconLabel: string;
     /** placeholder text for participants who does not have a display name*/
     displayNamePlaceholder?: string;
+    /** String shown when `participantState` is `Connecting` */
+    participantStateConnecting?: string;
+    /** String shown when `participantState` is `Ringing` */
+    participantStateRinging?: string;
+    /** String shown when `participantState` is `Hold` */
+    participantStateHold?: string;
 }
 
 /**
@@ -6058,6 +6076,12 @@ export declare type ParticipantsRemovedListener = (event: {
     removedBy: ChatParticipant;
 }) => void;
 
+/**
+ * @public
+ * The connection state of a call participant.
+ */
+export declare type ParticipantState = 'Idle' | 'Connecting' | 'Ringing' | 'Connected' | 'Hold' | 'InLobby' | 'EarlyMedia' | 'Disconnected';
+
 /**
  * An array of key value pairs that stores each sender's display name and last read message
  *
@@ -7108,15 +7132,9 @@ export declare interface VideoGalleryRemoteParticipant extends VideoGalleryParti
      * @beta
      * The connection state of the participant. For example, 'Hold', 'Connecting' etc.
      */
-    state?: VideoGalleryRemoteParticipantState;
+    state?: ParticipantState;
 }
 
-/**
- * @beta
- * The connection state of the participant. For example, 'Hold', 'Connecting' etc.
- */
-export declare type VideoGalleryRemoteParticipantState = 'Connecting' | 'Ringing' | 'Connected' | 'Hold';
-
 /**
  * Selector type for {@link VideoGallery} component.
  *
@@ -7294,7 +7312,7 @@ export declare interface VideoTileProps {
      * The call connection state of the participant.
      * For example, `Hold` means the participant is on hold.
      */
-    participantState?: VideoGalleryRemoteParticipantState;
+    participantState?: ParticipantState;
     strings?: VideoTileStrings;
 }