@azure/communication-react 1.11.1-alpha-202401040013 → 1.11.1-alpha-202401070014

package/dist/communication-react.d.ts

@@ -87,6 +87,7 @@ import { PersonaSize } from '@fluentui/react';
 import { PhoneNumberIdentifier } from '@azure/communication-common';
 import { PropertyChangedEvent } from '@azure/communication-calling';
 import { default as React_2 } from 'react';
+import { ReactionMessage } from '@azure/communication-calling';
 import type { RemoteParticipant } from '@azure/communication-calling';
 import { RemoteParticipantState as RemoteParticipantState_2 } from '@azure/communication-calling';
 import { RoomCallLocator } from '@azure/communication-calling';
@@ -2496,6 +2497,12 @@ export declare type CallParticipantListParticipant = ParticipantListParticipant
     isSpeaking?: boolean;
     /** Whether calling participant is raised hand */
     raisedHand?: RaisedHand;
+    /**
+     * Whether calling participant has reacted
+     *
+     * @beta
+     * */
+    reaction?: Reaction;
 };
 
 /**
@@ -2619,6 +2626,13 @@ export declare interface CallState {
      * Proxy of {@link @azure/communication-calling#RaiseHandCallFeature}.
      */
     raiseHand: RaiseHandCallFeature;
+    /**
+     * Proxy of {@link @azure/communication-calling#Call.ReactionMessage} with
+     * UI helper props receivedAt which indicates the timestamp when the message was received.
+     *
+     * @beta
+     */
+    localParticipantReaction?: ReactionState;
     /**
      * Stores the currently active screenshare participant's key. If there is no screenshare active, then this will be
      * undefined. You can use this key to access the remoteParticipant data in {@link CallState.remoteParticipants} object.
@@ -3121,12 +3135,16 @@ export declare interface CallWithChatAdapterSubscriptions {
     off(event: 'isSpokenLanguageChanged', listener: IsSpokenLanguageChangedListener): void;
     off(event: 'capabilitiesChanged', listener: CapabilitiesChangedListener): void;
     on(event: 'messageReceived', listener: MessageReceivedListener): void;
+    on(event: 'messageEdited', listener: MessageEditedListener): void;
+    on(event: 'messageDeleted', listener: MessageDeletedListener): void;
     on(event: 'messageSent', listener: MessageSentListener): void;
     on(event: 'messageRead', listener: MessageReadListener): void;
     on(event: 'chatParticipantsAdded', listener: ParticipantsAddedListener): void;
     on(event: 'chatParticipantsRemoved', listener: ParticipantsRemovedListener): void;
     on(event: 'chatError', listener: (e: AdapterError) => void): void;
     off(event: 'messageReceived', listener: MessageReceivedListener): void;
+    off(event: 'messageEdited', listener: MessageEditedListener): void;
+    off(event: 'messageDeleted', listener: MessageDeletedListener): void;
     off(event: 'messageSent', listener: MessageSentListener): void;
     off(event: 'messageRead', listener: MessageReadListener): void;
     off(event: 'chatParticipantsAdded', listener: ParticipantsAddedListener): void;
@@ -3666,7 +3684,7 @@ export declare interface CallWithChatControlOptions extends CommonCallControlOpt
  *
  * @public
  */
-export declare type CallWithChatEvent = 'callError' | 'chatError' | 'callEnded' | 'isMutedChanged' | 'callIdChanged' | 'isLocalScreenSharingActiveChanged' | 'displayNameChanged' | 'isSpeakingChanged' | 'callParticipantsJoined' | 'callParticipantsLeft' | 'selectedMicrophoneChanged' | 'selectedSpeakerChanged' | /* @conditional-compile-remove(close-captions) */ 'isCaptionsActiveChanged' | /* @conditional-compile-remove(close-captions) */ 'captionsReceived' | /* @conditional-compile-remove(close-captions) */ 'isCaptionLanguageChanged' | /* @conditional-compile-remove(close-captions) */ 'isSpokenLanguageChanged' | /* @conditional-compile-remove(capabilities) */ 'capabilitiesChanged' | 'messageReceived' | 'messageSent' | 'messageRead' | 'chatParticipantsAdded' | 'chatParticipantsRemoved';
+export declare type CallWithChatEvent = 'callError' | 'chatError' | 'callEnded' | 'isMutedChanged' | 'callIdChanged' | 'isLocalScreenSharingActiveChanged' | 'displayNameChanged' | 'isSpeakingChanged' | 'callParticipantsJoined' | 'callParticipantsLeft' | 'selectedMicrophoneChanged' | 'selectedSpeakerChanged' | /* @conditional-compile-remove(close-captions) */ 'isCaptionsActiveChanged' | /* @conditional-compile-remove(close-captions) */ 'captionsReceived' | /* @conditional-compile-remove(close-captions) */ 'isCaptionLanguageChanged' | /* @conditional-compile-remove(close-captions) */ 'isSpokenLanguageChanged' | /* @conditional-compile-remove(capabilities) */ 'capabilitiesChanged' | 'messageReceived' | 'messageEdited' | 'messageDeleted' | 'messageSent' | 'messageRead' | 'chatParticipantsAdded' | 'chatParticipantsRemoved';
 
 /**
  * @beta
@@ -4102,6 +4120,14 @@ export declare interface ChatAdapterSubscribers {
      * Subscribe function for 'messageReceived' event.
      */
     on(event: 'messageReceived', listener: MessageReceivedListener): void;
+    /**
+     * Subscribe function for 'messageEdited' event.
+     */
+    on(event: 'messageEdited', listener: MessageEditedListener): void;
+    /**
+     * Subscribe function for 'messageDeleted' event.
+     */
+    on(event: 'messageDeleted', listener: MessageDeletedListener): void;
     /**
      * Subscribe function for 'messageSent' event.
      */
@@ -4130,6 +4156,14 @@ export declare interface ChatAdapterSubscribers {
      * Unsubscribe function for 'messageReceived' event.
      */
     off(event: 'messageReceived', listener: MessageReceivedListener): void;
+    /**
+     * Unsubscribe function for 'messageEdited' event.
+     */
+    off(event: 'messageEdited', listener: MessageEditedListener): void;
+    /**
+     * Unsubscribe function for 'messageDeleted' event.
+     */
+    off(event: 'messageDeleted', listener: MessageDeletedListener): void;
     /**
      * Unsubscribe function for 'messageSent' event.
      */
@@ -6398,6 +6432,8 @@ export declare interface DialpadProps {
     /**  boolean input to determine if dialpad is in mobile view, default false */
     isMobile?: boolean;
     styles?: DialpadStyles;
+    /** Disables DTMF sounds when dialpad buttons are pressed. the actual tones are still sent to the call. */
+    disableDtmfPlayback?: boolean;
 }
 
 /**
@@ -7622,6 +7658,20 @@ export declare interface MessageCommon {
  */
 export declare type MessageContentType = 'text' | 'html' | 'richtext/html' | 'unknown';
 
+/**
+ * Callback for {@link ChatAdapterSubscribers} 'messageDeleted' event.
+ *
+ * @public
+ */
+export declare type MessageDeletedListener = MessageReceivedListener;
+
+/**
+ * Callback for {@link ChatAdapterSubscribers} 'messageEdited' event.
+ *
+ * @public
+ */
+export declare type MessageEditedListener = MessageReceivedListener;
+
 /**
  * Props to render a single message.
  *
@@ -8882,6 +8932,39 @@ export declare interface RaiseHandCallFeature {
     localParticipantRaisedHand?: RaisedHandState;
 }
 
+/**
+ * Reaction state with reaction type to render
+ *
+ * @beta
+ */
+export declare type Reaction = {
+    /**
+     * Specifies the type of reaction videoTile should render i.e. like, heart etc.
+     */
+    reactionType: string;
+    /**
+     * Received timestamp for the message as default Date format.
+     */
+    receivedAt: Date;
+};
+
+/**
+ * State only version of {@link @azure/communication-calling#Call.ReactionMessage} with UI helper props receivedAt.
+ * Reaction state with a timestamp which helps UI to decide to render the reaction accordingly.
+ *
+ * @beta
+ */
+export declare type ReactionState = {
+    /**
+     * Reaction message from the meeting {@link @azure/communication-calling#Call.ReactionMessage}
+     */
+    reactionMessage: ReactionMessage;
+    /**
+     * Received timestamp of the reaction message in a meeting.
+     */
+    receivedAt: Date;
+};
+
 /**
  * An array of key value pairs that stores each sender's display name and last read message
  *
@@ -8953,6 +9036,13 @@ export declare interface RemoteParticipantState {
      * Proxy of {@link @azure/communication-calling#Call.RaisedHand.raisedHands}.
      */
     raisedHand?: RaisedHandState;
+    /**
+     * Proxy of {@link @azure/communication-calling#Call.ReactionMessage} with
+     * UI helper props receivedAt which indicates the timestamp when the message was received.
+     *
+     * @beta
+     */
+    reactionState?: ReactionState;
 }
 
 /**
@@ -9365,6 +9455,7 @@ export declare interface SpokenLanguageStrings {
  *   - RecordingCallFeature 'isRecordingActiveChanged'
  *   - RaiseHandCallFeature 'raisedHandEvent'
  *   - RaiseHandCallFeature 'loweredHandEvent'
+ *   - ReactionCallFeature 'reaction'
  *
  * @public
  */
@@ -10400,6 +10491,12 @@ export declare type VideoGalleryLayout = 'default' | 'floatingLocalVideo' | /* @
 export declare interface VideoGalleryLocalParticipant extends VideoGalleryParticipant {
     /** Whether local participant is raised a hand */
     raisedHand?: RaisedHand;
+    /**
+     * Whether local participant has reacted
+     *
+     * @beta
+     * */
+    reaction?: Reaction;
 }
 
 /**
@@ -10538,6 +10635,12 @@ export declare interface VideoGalleryRemoteParticipant extends VideoGalleryParti
     state?: ParticipantState;
     /** Whether participant is raised a hand */
     raisedHand?: RaisedHand;
+    /**
+     * Whether participant has reacted
+     *
+     * @beta
+     * */
+    reaction?: Reaction;
 }
 
 /**
@@ -10775,6 +10878,8 @@ export declare interface VideoTileProps {
     isSpeaking?: boolean;
     /** Whether the participant is raised hand. Show a indicator (border) and icon with order */
     raisedHand?: RaisedHand;
+    /** When the participant has reacted, animate the reaction. */
+    reaction?: Reaction;
     /**
      * The call connection state of the participant.
      * For example, `Hold` means the participant is on hold.