@azure/communication-react 1.7.0-beta.1 → 1.7.0-beta.2

package/dist/communication-react.d.ts

@@ -15,8 +15,6 @@
  * @packageDocumentation
  */
 
-/// <reference types="react" />
-
 import { AddPhoneNumberOptions } from '@azure/communication-calling';
 import { AudioDeviceInfo } from '@azure/communication-calling';
 import { BackgroundBlurConfig } from '@azure/communication-calling-effects';
@@ -70,6 +68,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 { MicrosoftBotKind } from '@azure/communication-common';
 import { MicrosoftTeamsUserIdentifier } from '@azure/communication-common';
 import { MicrosoftTeamsUserKind } from '@azure/communication-common';
 import type { NetworkDiagnosticChangedEventArgs } from '@azure/communication-calling';
@@ -428,6 +427,36 @@ export declare interface BaseCustomStyles {
     root?: IStyle;
 }
 
+/**
+ * Base interface that all Meta Data should extend.
+ * Typically used for ACS to ACS file transfers.
+ * @beta
+ */
+export declare interface BaseFileMetadata {
+    /**
+     * File name to be displayed.
+     */
+    name: string;
+    /**
+     * Extension is used for rendering the file icon.
+     * An unknown extension will be rendered as a generic icon.
+     * Example: `jpeg`
+     */
+    extension: string;
+    /**
+     * Download URL for the file.
+     */
+    url: string;
+    /**
+     * Unique ID of the file.
+     */
+    id: string;
+    /**
+     * Attachment Type
+     */
+    attachmentType: FileMetadataAttachmentType;
+}
+
 /**
  * Content blocked message type.
  *
@@ -5846,6 +5875,11 @@ export declare interface ErrorBarProps extends IMessageBarProps {
      * @defaultValue false
      */
     ignorePremountErrors?: boolean;
+    /**
+     * Callback called when the dismiss button is triggered.
+     * Use this to control errors shown when they dismissed by the user.
+     */
+    onDismissError?: (dismissedError: ActiveErrorMessage) => void;
 }
 
 /**
@@ -6048,30 +6082,22 @@ export declare type FileDownloadHandler = (userId: string, fileMetadata: FileMet
  * Meta Data containing information about the uploaded file.
  * @beta
  */
-export declare interface FileMetadata {
-    attachmentType: FileMetadataAttachmentType;
-    id: string;
-    /**
-     * File name to be displayed.
-     */
-    name: string;
-    /**
-     * Extension is used for rendering the file icon.
-     * An unknown extension will be rendered as a generic icon.
-     * Example: `jpeg`
-     */
-    extension: string;
-    /**
-     * Download URL for the file.
-     */
-    url: string;
-    previewUrl?: string;
-}
+export declare type FileMetadata = FileSharingMetadata | /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */ ImageFileMetadata;
+
+/**
+ * @beta
+ */
+export declare type FileMetadataAttachmentType = 'fileSharing' | /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */ 'inlineImage' | 'unknown';
 
 /**
+ * Meta Data containing basic information about the uploaded file.
+ * Typically used for ACS to ACS file transfers.
  * @beta
  */
-export declare type FileMetadataAttachmentType = 'fileSharing' | /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */ 'teamsInlineImage' | 'unknown';
+export declare interface FileSharingMetadata extends BaseFileMetadata {
+    attachmentType: 'fileSharing';
+    payload?: Record<string, string>;
+}
 
 /**
  * Properties for configuring the File Sharing feature.
@@ -6452,6 +6478,15 @@ export declare interface _Identifiers {
     mentionSuggestionItem: string;
 }
 
+/**
+ * Meta Data containing data for images.
+ * @beta
+ */
+export declare interface ImageFileMetadata extends BaseFileMetadata {
+    attachmentType: 'inlineImage';
+    previewUrl?: string;
+}
+
 /**
  * @beta
  * This contains a readonly array that returns all the active `incomingCalls`.
@@ -7560,7 +7595,7 @@ export declare interface ParticipantItemProps {
      * Optional callback when component is clicked
      */
     onClick?: (props?: ParticipantItemProps) => void;
-    /** prop to determine if we should show tooltip for participants or not */
+    /** Optional value to determine if the tooltip should be shown for participants or not */
     showParticipantOverflowTooltip?: boolean;
     /**
      * Optional value to determine and display a participants connection status.
@@ -7676,7 +7711,7 @@ export declare type ParticipantListProps = {
     onParticipantClick?: (participant?: ParticipantListParticipant) => void;
     /** Styles for the {@link ParticipantList} */
     styles?: ParticipantListStyles;
-    /** prop to determine if we should show tooltip for participants or not */
+    /** Optional value to determine if the tooltip should be shown for participants or not */
     showParticipantOverflowTooltip?: boolean;
     /** Optional aria-lablledby prop that prefixes each ParticipantItem aria-label */
     participantAriaLabelledBy?: string;
@@ -7814,7 +7849,7 @@ export declare interface ParticipantsButtonProps extends ControlBarButtonProps {
      * Optional strings to override in component
      */
     strings?: Partial<ParticipantsButtonStrings>;
-    /** prop to determine if we should show tooltip for participants or not */
+    /** Optional value to determine if the tooltip should be shown for participants or not */
     showParticipantOverflowTooltip?: boolean;
 }
 
@@ -7955,7 +7990,7 @@ export declare interface RemoteParticipantState {
     /**
      * Proxy of {@link @azure/communication-calling#RemoteParticipant.identifier}.
      */
-    identifier: CommunicationUserKind | PhoneNumberKind | MicrosoftTeamsUserKind | UnknownIdentifierKind;
+    identifier: CommunicationUserKind | PhoneNumberKind | MicrosoftTeamsUserKind | UnknownIdentifierKind | /* @conditional-compile-remove(communication-common-beta-v3) */ MicrosoftBotKind;
     /**
      * Proxy of {@link @azure/communication-calling#RemoteParticipant.displayName}.
      */