@azure/communication-react 1.5.1-alpha-202302010014 → 1.5.1-alpha-202302030014

package/dist/communication-react.d.ts

@@ -4275,7 +4275,7 @@ export declare const createStatefulChatClient: (args: StatefulChatClientArgs, op
 /**
  * @beta
  */
-export declare const createTeamsCallAdapter: ({ userId, credential, locator }: TeamsCallAdapterArgs) => Promise<TeamsCallAdapter>;
+export declare const createTeamsCallAdapter: ({ userId, credential, locator, options }: TeamsCallAdapterArgs) => Promise<TeamsCallAdapter>;
 
 /**
  * Create a {@link TeamsCallAdapter} using the provided {@link StatefulCallClient}.
@@ -4285,7 +4285,7 @@ export declare const createTeamsCallAdapter: ({ userId, credential, locator }: T
  *
  * @beta
  */
-export declare const createTeamsCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: TeamsCallAgent, locator: CallAdapterLocator) => Promise<TeamsCallAdapter>;
+export declare const createTeamsCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: TeamsCallAgent, locator: CallAdapterLocator, options?: TeamsAdapterOptions | undefined) => Promise<TeamsCallAdapter>;
 
 /**
  * Object returned after creating a local or remote VideoStream.
@@ -5255,6 +5255,10 @@ export declare interface ErrorBarStrings {
      * An error message when joining a call fails specifically due to an invalid meeting link.
      */
     failedToJoinCallInvalidMeetingLink?: string;
+    /**
+     * Generic message for when screen sharing fails
+     */
+    startScreenSharingGeneric?: string;
 }
 
 /**
@@ -6526,6 +6530,13 @@ export declare interface NetworkDiagnosticsState {
     latest: LatestNetworkDiagnostics;
 }
 
+/**
+ * Callback function used to provide custom data to build profile for a user.
+ *
+ * @beta
+ */
+export declare type OnFetchProfileCallback = (userId: string) => Promise<Profile | undefined>;
+
 /**
  * A custom rendered callback that allows users to customize the rendering of a Persona Component.
  *
@@ -6954,6 +6965,18 @@ export declare type ParticipantsRemovedListener = (event: {
  */
 export declare type ParticipantState = 'Idle' | 'Connecting' | 'Ringing' | 'Connected' | 'Hold' | 'InLobby' | 'EarlyMedia' | 'Disconnected';
 
+/**
+ * The profile of a user.
+ *
+ * @beta
+ */
+export declare type Profile = {
+    /**
+     * Primary text to display, usually the name of the person.
+     */
+    displayName?: string;
+};
+
 /**
  * An array of key value pairs that stores each sender's display name and last read message
  *
@@ -7616,6 +7639,20 @@ export declare interface SystemMessageCommon extends MessageCommon {
     iconName: string;
 }
 
+/**
+ * Optional parameters to create {@link AzureCommunicationCallAdapter}
+ *
+ * @beta
+ */
+export declare type TeamsAdapterOptions = {
+    /**
+     * Use this to fetch profile information which will override data in {@link CallAdapterState} like display name
+     * The onFetchProfile is fetch-and-forget one time action for each user, once a user profile is updated, the value will be cached
+     * and would not be updated again within the lifecycle of adapter.
+     */
+    onFetchProfile?: OnFetchProfileCallback;
+};
+
 /**
  * An Adapter interface specific for Teams identity which extends {@link CommonCallAdapter}.
  *
@@ -7655,6 +7692,10 @@ export declare type TeamsCallAdapterArgs = {
     userId: MicrosoftTeamsUserIdentifier;
     credential: CommunicationTokenCredential;
     locator: TeamsMeetingLinkLocator;
+    /**
+     * Optional parameters for the {@link TeamsCallAdapter} created
+     */
+    options?: TeamsAdapterOptions;
 };
 
 /**