@azure/communication-react 1.10.0-beta.1 → 1.10.1-alpha-202311110012

package/dist/communication-react.d.ts

@@ -44,7 +44,7 @@ import { CommunicationIdentifier } from '@azure/communication-common';
 import { CommunicationIdentifierKind } from '@azure/communication-common';
 import { CommunicationTokenCredential } from '@azure/communication-common';
 import { CommunicationUserIdentifier } from '@azure/communication-common';
-import { CommunicationUserKind } from '@azure/communication-common';
+import type { CommunicationUserKind } from '@azure/communication-common';
 import { CreateViewOptions } from '@azure/communication-calling';
 import { DeviceAccess } from '@azure/communication-calling';
 import { DeviceManager } from '@azure/communication-calling';
@@ -73,9 +73,7 @@ import { LatestNetworkDiagnostics } from '@azure/communication-calling';
 import { LocalVideoStream } from '@azure/communication-calling';
 import type { MediaDiagnosticChangedEventArgs } from '@azure/communication-calling';
 import { MediaStreamType } from '@azure/communication-calling';
-import { MicrosoftTeamsAppKind } from '@azure/communication-common';
 import { MicrosoftTeamsUserIdentifier } from '@azure/communication-common';
-import { MicrosoftTeamsUserKind } from '@azure/communication-common';
 import type { NetworkDiagnosticChangedEventArgs } from '@azure/communication-calling';
 import { PartialTheme } from '@fluentui/react';
 import { ParticipantCapabilities } from '@azure/communication-calling';
@@ -85,7 +83,6 @@ import { PersonaInitialsColor } from '@fluentui/react';
 import { PersonaPresence } from '@fluentui/react';
 import { PersonaSize } from '@fluentui/react';
 import { PhoneNumberIdentifier } from '@azure/communication-common';
-import { PhoneNumberKind } from '@azure/communication-common';
 import { PropertyChangedEvent } from '@azure/communication-calling';
 import { default as React_2 } from 'react';
 import type { RemoteParticipant } from '@azure/communication-calling';
@@ -102,7 +99,6 @@ import { TeamsMeetingLinkLocator } from '@azure/communication-calling';
 import { Theme } from '@fluentui/react';
 import { TransferRequestedEventArgs } from '@azure/communication-calling';
 import { TypingIndicatorReceivedEvent } from '@azure/communication-chat';
-import { UnknownIdentifierKind } from '@azure/communication-common';
 import { VideoDeviceInfo } from '@azure/communication-calling';
 import { VideoEffectName } from '@azure/communication-calling';
 import { VideoStreamRenderer } from '@azure/communication-calling';
@@ -242,9 +238,11 @@ export declare type AreParamEqual<A extends (props: any) => JSX.Element | undefi
 export declare type AreTypeEqual<A, B> = A extends B ? (B extends A ? true : false) : false;
 
 /**
+ * Meta Data of the attachment object returned by the ACS SDK.
  * @beta
  */
 export declare interface AttachmentDownloadResult {
+    attachmentId: string;
     blobUrl: string;
 }
 
@@ -954,6 +952,14 @@ export declare type CallAdapterClientState = {
      * Call from transfer request accepted by local user
      */
     acceptedTransferCallState?: CallState;
+    /**
+     * Hide attendee names in teams meeting
+     */
+    hideAttendeeNames?: boolean;
+    /**
+     * State to track the sounds to be used in the call.
+     */
+    sounds?: CallingSounds;
 };
 
 /**
@@ -1535,6 +1541,40 @@ export declare type CallCompositeOptions = {
          */
         layout?: VideoGalleryLayout;
     };
+    /**
+     * Logo displayed on the configuration page.
+     */
+    logo?: {
+        /**
+         * URL for the logo image.
+         *
+         * @remarks
+         * Recommended size is 80x80 pixels.
+         */
+        url: string;
+        /**
+         * Alt text for the logo image.
+         */
+        alt?: string;
+        /**
+         * The logo can be displayed as a circle or a square.
+         *
+         * @defaultValue 'circle'
+         */
+        shape?: 'circle' | 'square';
+    };
+    /**
+     * Background image displayed on the configuration page.
+     */
+    backgroundImage?: {
+        /**
+         * URL for the background image.
+         *
+         * @remarks
+         * Background image should be larger than 576x567 pixels and smaller than 2048x2048 pixels pixels.
+         */
+        url: string;
+    };
 };
 
 /**
@@ -2132,6 +2172,10 @@ export declare interface CallCompositeStrings {
      * All strings for capability changed notification
      */
     capabilityChangedNotification?: CapabilityChangedNotificationStrings;
+    /**
+     * String for the dismiss control on the local and remote PIP on mobile
+     */
+    dismissModalAriaLabel?: string;
 }
 
 /**
@@ -2146,7 +2190,7 @@ export declare type CallControlDisplayType = 'default' | 'compact';
  *
  * @public
  */
-export declare type CallControlOptions = (CommonCallControlOptions & {
+export declare type CallControlOptions = CommonCallControlOptions & {
     /**
      * Show, Hide or Disable participants button during a call. This is the option only work for legacyControl bar.
      * @defaultValue true
@@ -2155,7 +2199,7 @@ export declare type CallControlOptions = (CommonCallControlOptions & {
         disabled: boolean;
     };
     legacyControlBarExperience?: boolean;
-});
+};
 
 /**
  * Callback for {@link CallAdapterSubscribers} 'callEnded' event.
@@ -2263,6 +2307,17 @@ export declare type CallingHandlersOptions = {
  */
 export declare type CallingReturnProps<Component extends (props: any) => JSX.Element> = GetCallingSelector<Component> extends (state: CallClientState, props: any) => any ? ReturnType<GetCallingSelector<Component>> & Common<CallingHandlers, Parameters<Component>[0]> : never;
 
+/**
+ * @beta
+ * Type for representing a set of sounds to use for different calling events
+ */
+export declare type CallingSounds = {
+    /**
+     * Sound to be played when the call ends
+     */
+    callEnded?: SoundEffect;
+};
+
 /**
  * Custom Fluent theme palette used by calling related components in this library.
  *
@@ -2457,6 +2512,10 @@ export declare interface CallState {
      * Proxy of {@link @azure/communication-calling#CapabilitiesFeature}.
      */
     capabilitiesFeature?: CapabilitiesFeatureState;
+    /**
+     * Hide attendee names in teams meeting
+     */
+    hideAttendeeNames?: boolean;
 }
 
 /**
@@ -2761,7 +2820,7 @@ export declare interface CallWithChatAdapterManagement {
     /** @beta */
     updateFileUploadMetadata: (id: string, metadata: FileMetadata) => void;
     downloadAttachments: (options: {
-        attachmentUrls: string[];
+        attachmentUrls: Record<string, string>;
     }) => Promise<AttachmentDownloadResult[]>;
     /**
      * Puts the Call in a Localhold.
@@ -2969,6 +3028,8 @@ export declare interface CallWithChatClientState {
     onResolveVideoEffectDependency?: () => Promise<VideoBackgroundEffectsDependency>;
     /** State to track the selected video background effect */
     selectedVideoBackgroundEffect?: VideoBackgroundEffect;
+    /** Hide attendee names in teams meeting */
+    hideAttendeeNames?: boolean;
 }
 
 /**
@@ -3142,6 +3203,40 @@ export declare type CallWithChatCompositeOptions = {
          */
         layout?: VideoGalleryLayout;
     };
+    /**
+     * Logo displayed on the configuration page.
+     */
+    logo?: {
+        /**
+         * URL for the logo image.
+         *
+         * @remarks
+         * Recommended size is 80x80 pixels.
+         */
+        url: string;
+        /**
+         * Alt text for the logo image.
+         */
+        alt?: string;
+        /**
+         * The logo can be displayed as a circle or a square.
+         *
+         * @defaultValue 'circle'
+         */
+        shape?: 'circle' | 'square';
+    };
+    /**
+     * Background image displayed on the configuration page.
+     */
+    backgroundImage?: {
+        /**
+         * URL for the background image.
+         *
+         * @remarks
+         * Background image should be larger than 576x567 pixels and smaller than 2048x2048 pixels pixels.
+         */
+        url: string;
+    };
 };
 
 /**
@@ -3780,7 +3875,7 @@ export declare type CaptionsReceivedListener = (event: {
  *
  * @public
  */
-export declare type ChatAdapter = ChatAdapterThreadManagement & AdapterState<ChatAdapterState> & Disposable & ChatAdapterSubscribers & /* @conditional-compile-remove(file-sharing) */ FileUploadAdapter;
+export declare type ChatAdapter = ChatAdapterThreadManagement & AdapterState<ChatAdapterState> & Disposable & ChatAdapterSubscribers & FileUploadAdapter;
 
 /**
  * {@link ChatAdapter} state.
@@ -3888,7 +3983,7 @@ export declare interface ChatAdapterThreadManagement {
     /**
      * Update a message content.
      */
-    updateMessage(messageId: string, content: string, metadata?: Record<string, string>, /* @conditional-compile-remove(file-sharing) */ options?: {
+    updateMessage(messageId: string, content: string, metadata?: Record<string, string>, options?: {
         attachedFilesMetadata?: FileMetadata[];
     }): Promise<void>;
     /**
@@ -3904,7 +3999,7 @@ export declare interface ChatAdapterThreadManagement {
      */
     loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>;
     downloadAttachments: (options: {
-        attachmentUrls: string[];
+        attachmentUrls: Record<string, string>;
     }) => Promise<AttachmentDownloadResult[]>;
 }
 
@@ -4178,7 +4273,8 @@ export declare type ChatHandlers = {
     onRemoveParticipant: (userId: string) => Promise<void>;
     updateThreadTopicName: (topicName: string) => Promise<void>;
     onLoadPreviousChatMessages: (messagesToLoad: number) => Promise<boolean>;
-    onUpdateMessage: (messageId: string, content: string, /* @conditional-compile-remove(file-sharing) */ metadata?: Record<string, string>, /* @conditional-compile-remove(file-sharing) */ options?: {
+    onUpdateMessage: (messageId: string, content: string, options?: {
+        metadata?: Record<string, string>;
         attachedFilesMetadata?: FileMetadata[];
     }) => Promise<void>;
     onDeleteMessage: (messageId: string) => Promise<void>;
@@ -4418,6 +4514,15 @@ export declare type CommonCallAdapterOptions = {
      * and would not be updated again within the lifecycle of adapter.
      */
     onFetchProfile?: OnFetchProfileCallback;
+    /**
+     * Options for calling sounds
+     */
+    soundOptions?: {
+        /**
+         * Sounds to use for calling events
+         */
+        callingSounds?: CallingSounds;
+    };
 };
 
 /**
@@ -4490,8 +4595,6 @@ export declare type CommonCallControlOptions = {
     };
     /**
      * Inject custom buttons in the call controls.
-     *
-     * @beta
      */
     onFetchCustomButtonProps?: CustomCallControlButtonCallback[];
     holdButton?: boolean | {
@@ -4878,6 +4981,8 @@ export declare interface ComponentStrings {
     verticalGallery: VerticalGalleryStrings;
     /** Strings for the participant list component */
     ParticipantList: ParticipantListStrings;
+    /** Strings for the attendee role */
+    AttendeeRole: string;
 }
 
 /**
@@ -5125,6 +5230,12 @@ export declare interface ControlBarButtonProps extends IButtonProps {
      * Key to use for the Label component
      */
     labelKey?: string;
+    /**
+     * Disable tooltip.
+     *
+     * @defaultValue 'false'
+     */
+    disableTooltip?: boolean;
     /**
      * Id to use for the tooltip host.
      *
@@ -5244,7 +5355,7 @@ export declare const createAzureCommunicationCallAdapter: ({ userId, displayName
  *
  * @public
  */
-export declare const createAzureCommunicationCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator, /* @conditional-compile-remove(video-background-effects) */ options?: AzureCommunicationCallAdapterOptions) => Promise<CallAdapter>;
+export declare const createAzureCommunicationCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator, options?: AzureCommunicationCallAdapterOptions) => Promise<CallAdapter>;
 
 /**
  * Create a CallWithChatAdapter backed by Azure Communication services
@@ -5282,7 +5393,7 @@ export declare const createAzureCommunicationChatAdapter: ({ endpoint: endpointU
  *
  * @public
  */
-export declare function createAzureCommunicationChatAdapterFromClient(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient, /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */ options?: {
+export declare function createAzureCommunicationChatAdapterFromClient(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient, options?: {
     credential?: CommunicationTokenCredential;
 }): Promise<ChatAdapter>;
 
@@ -5291,7 +5402,7 @@ export declare function createAzureCommunicationChatAdapterFromClient(chatClient
  *
  * @public
  */
-export declare type CreateDefaultCallingHandlers = (callClient: StatefulCallClient, callAgent: CallAgent | undefined, deviceManager: StatefulDeviceManager | undefined, call: Call | undefined, /* @conditional-compile-remove(video-background-effects) */ options?: CallingHandlersOptions) => CallingHandlers;
+export declare type CreateDefaultCallingHandlers = (callClient: StatefulCallClient, callAgent: CallAgent | undefined, deviceManager: StatefulDeviceManager | undefined, call: Call | undefined, options?: CallingHandlersOptions) => CallingHandlers;
 
 /**
  * Create the default implementation of {@link CallingHandlers} for teams call.
@@ -5555,7 +5666,7 @@ export declare const darkTheme: PartialTheme & CallingTheme & /* @conditional-co
  * @beta
  * `DeclarativeCallAgent` extends and proxies the {@link @azure/communication-calling#CallAgent}
  */
-export declare type DeclarativeCallAgent = CallAgent & /* @conditional-compile-remove(one-to-n-calling) */ IncomingCallManagement;
+export declare type DeclarativeCallAgent = CallAgent & IncomingCallManagement;
 
 /**
  * @beta
@@ -7551,7 +7662,7 @@ export declare type MessageThreadProps = {
      * @param attachment - FileMetadata object we want to render
      * @beta
      */
-    onFetchAttachments?: (attachment: FileMetadata) => Promise<AttachmentDownloadResult[]>;
+    onFetchAttachments?: (attachments: FileMetadata[]) => Promise<AttachmentDownloadResult[]>;
     /**
      * Optional callback to edit a message.
      *
@@ -8561,7 +8672,7 @@ export declare interface RemoteParticipantState {
     /**
      * Proxy of {@link @azure/communication-calling#RemoteParticipant.identifier}.
      */
-    identifier: CommunicationUserKind | PhoneNumberKind | MicrosoftTeamsUserKind | UnknownIdentifierKind | MicrosoftTeamsAppKind;
+    identifier: CommunicationIdentifierKind;
     /**
      * Proxy of {@link @azure/communication-calling#RemoteParticipant.displayName}.
      */
@@ -8918,6 +9029,21 @@ export declare interface SitePermissionsStyles extends BaseCustomStyles {
     troubleshootingLink?: ILinkStyles;
 }
 
+/**
+ * @beta
+ * Type for representing a custom sound to use for a calling event
+ */
+export declare type SoundEffect = {
+    /**
+     * Path to sound effect
+     */
+    path: string;
+    /**
+     * type of file format for the sound effect
+     */
+    fileType?: 'mp3' | 'wav' | 'ogg' | 'aac' | 'flac';
+};
+
 /**
  * @public
  * spoken language strings for captions setting modal
@@ -9639,7 +9765,8 @@ export declare interface UnsupportedOperatingSystemStrings {
  * @public
  * Callback function run when a message is updated.
  */
-export declare type UpdateMessageCallback = (messageId: string, content: string, /* @conditional-compile-remove(file-sharing) */ metadata?: Record<string, string>, /* @conditional-compile-remove(file-sharing) */ options?: {
+export declare type UpdateMessageCallback = (messageId: string, content: string, options?: {
+    metadata?: Record<string, string>;
     attachedFilesMetadata?: FileMetadata[];
 }) => Promise<void>;
 
@@ -9966,7 +10093,7 @@ export declare const VideoGallery: (props: VideoGalleryProps) => JSX.Element;
 /**
  * @public
  */
-export declare type VideoGalleryLayout = 'default' | 'floatingLocalVideo' | /* @conditional-compile-remove(gallery-layouts) */ 'speaker' | /* @conditional-compile-remove(gallery-layouts) */ 'focusedContent';
+export declare type VideoGalleryLayout = 'default' | 'floatingLocalVideo' | /* @conditional-compile-remove(gallery-layouts) */ 'speaker' | /* @conditional-compile-remove(large-gallery) */ 'largeGallery' | /* @conditional-compile-remove(gallery-layouts) */ 'focusedContent';
 
 /**
  * The state of the local participant in the {@link VideoGallery}.