@azure/communication-react 1.7.0-alpha-202308090014 → 1.7.0-alpha-202308100014

package/dist/communication-react.d.ts

@@ -89,7 +89,7 @@ import { PersonaSize } from '@fluentui/react';
 import { PhoneNumberIdentifier } from '@azure/communication-common';
 import { PhoneNumberKind } from '@azure/communication-common';
 import { PropertyChangedEvent } from '@azure/communication-calling';
-import { RaisedHand } from '@azure/communication-calling';
+import { RaisedHand as RaisedHand_2 } from '@azure/communication-calling';
 import { default as React_2 } from 'react';
 import type { RemoteParticipant } from '@azure/communication-calling';
 import { RemoteParticipantState as RemoteParticipantState_2 } from '@azure/communication-calling';
@@ -2170,6 +2170,7 @@ export declare interface CallingTheme {
         callRedDark: string;
         callRedDarker: string;
         iconWhite: string;
+        raiseHandGold: string;
     };
 }
 
@@ -2187,6 +2188,8 @@ export declare type CallParticipantListParticipant = ParticipantListParticipant
     isMuted?: boolean;
     /** Whether calling participant is speaking */
     isSpeaking?: boolean;
+    /** Whether calling participant is raised hand */
+    raisedHand?: RaisedHand;
 };
 
 /**
@@ -4577,6 +4580,8 @@ export declare interface ComponentStrings {
     participantsButton: ParticipantsButtonStrings;
     /** Strings for ScreenShareButton */
     screenShareButton: ScreenShareButtonStrings;
+    /** Strings for RaiseHandButton */
+    raiseHandButton: RaiseHandButtonStrings;
     /** Strings for TypingIndicator */
     typingIndicator: TypingIndicatorStrings;
     /** Strings for SendBox */
@@ -5363,6 +5368,8 @@ export declare const DEFAULT_COMPONENT_ICONS: {
     ControlButtonParticipantsContextualMenuItem: JSX.Element;
     ControlButtonScreenShareStart: JSX.Element;
     ControlButtonScreenShareStop: JSX.Element;
+    ControlButtonRaiseHand: JSX.Element;
+    ControlButtonLowerHand: JSX.Element;
     CancelFileUpload: JSX.Element;
     DownloadFile: JSX.Element;
     DataLossPreventionProhibited: JSX.Element;
@@ -5514,6 +5521,8 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     MoreDrawerSpeakers?: JSX.Element | undefined;
     ChatMessageOptions: JSX.Element;
     ControlButtonParticipantsContextualMenuItem: JSX.Element;
+    ControlButtonRaiseHand: JSX.Element;
+    ControlButtonLowerHand: JSX.Element;
     CancelFileUpload: JSX.Element;
     DownloadFile: JSX.Element;
     DataLossPreventionProhibited: JSX.Element;
@@ -8206,6 +8215,50 @@ export declare type Profile = {
     displayName?: string;
 };
 
+/**
+ * Raised hand state with order
+ *
+ * @public
+ */
+export declare type RaisedHand = {
+    order: number;
+};
+
+/**
+ * Props for {@link RaiseHandButton}.
+ *
+ * @public
+ */
+export declare interface RaiseHandButtonProps extends ControlBarButtonProps {
+    /**
+     * Utility property for using this component with `communication react eventHandlers`.
+     * Maps directly to the `onClick` property.
+     */
+    onToggleRaiseHand?: () => Promise<void>;
+    /**
+     * Optional strings to override in component
+     */
+    strings?: Partial<RaiseHandButtonStrings>;
+}
+
+/**
+ * Strings of {@link RaiseHandButton} that can be overridden.
+ *
+ * @public
+ */
+export declare interface RaiseHandButtonStrings {
+    /** Label when button is on. */
+    onLabel: string;
+    /** Label when button is off. */
+    offLabel: string;
+    /** * Tooltip content when the button is disabled. */
+    tooltipDisabledContent?: string;
+    /** Tooltip content when the button is on. */
+    tooltipOnContent?: string;
+    /** Tooltip content when the button is off. */
+    tooltipOffContent?: string;
+}
+
 /**
  * State only version of {@link @azure/communication-calling#RaiseHandCallFeature}. {@link StatefulCallClient} will
  * automatically listen for raised hands on the call and update the state exposed by {@link StatefulCallClient} accordingly.
@@ -8216,11 +8269,11 @@ export declare interface RaiseHandCallFeature {
     /**
      * Proxy of {@link @azure/communication-calling#RaiseHandCallFeature.raisedHands}.
      */
-    raisedHands: RaisedHand[];
+    raisedHands: RaisedHand_2[];
     /**
      * Contains information for local participant from list {@link @azure/communication-calling#RaiseHandCallFeature.raisedHands}.
      */
-    localParticipantRaisedHand?: RaisedHand;
+    localParticipantRaisedHand?: RaisedHand_2;
 }
 
 /**
@@ -8293,7 +8346,7 @@ export declare interface RemoteParticipantState {
     /**
      * Proxy of {@link @azure/communication-calling#Call.RaisedHand.raisedHands}.
      */
-    raisedHand?: RaisedHand;
+    raisedHand?: RaisedHand_2;
 }
 
 /**
@@ -9615,7 +9668,10 @@ export declare type VideoGalleryLayout = 'default' | 'floatingLocalVideo';
  *
  * @public
  */
-export declare type VideoGalleryLocalParticipant = VideoGalleryParticipant;
+export declare interface VideoGalleryLocalParticipant extends VideoGalleryParticipant {
+    /** Whether local participant is raised a hand */
+    raisedHand?: RaisedHand;
+}
 
 /**
  * The state of a participant in the {@link VideoGallery}.
@@ -9751,6 +9807,8 @@ export declare interface VideoGalleryRemoteParticipant extends VideoGalleryParti
      * The connection state of the participant. For example, 'Hold', 'Connecting' etc.
      */
     state?: ParticipantState;
+    /** Whether participant is raised a hand */
+    raisedHand?: RaisedHand;
 }
 
 /**
@@ -9981,6 +10039,8 @@ export declare interface VideoTileProps {
     noVideoAvailableAriaLabel?: string;
     /** Whether the participant in the videoTile is speaking. Shows a speaking indicator (border). */
     isSpeaking?: boolean;
+    /** Whether the participant is raised hand. Show a indicator (border) and order icon */
+    raisedHand?: RaisedHand;
     /**
      * The call connection state of the participant.
      * For example, `Hold` means the participant is on hold.