Skip to content

Custom data model to allow changing display name of call queues #3148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mgamis-msft merged 12 commits into from
Jun 13, 2023
Merged

Custom data model to allow changing display name of call queues #3148

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
623508f
Added onFetchProfile to CommonCallAdapterOptions.
mgamis-msft May 19, 2023
70aa6c1
Change files
mgamis-msft Jun 5, 2023
d5e1029
Duplicate change files for beta
mgamis-msft Jun 5, 2023
dcaea89
Change files
mgamis-msft Jun 5, 2023
dd669ce
Duplicate change files for beta
mgamis-msft Jun 5, 2023
297dbb6
Fix restricted import
mgamis-msft Jun 5, 2023
ba28b12
api update
mgamis-msft Jun 5, 2023
ebc3bd2
Fixed createProfileStateModifier
mgamis-msft Jun 8, 2023
b094965
Merge branch 'main' into mgamis/custom-data-model-to-change-display-name
dmceachernmsft Jun 8, 2023
10ee1d2
Merge branch 'main' into mgamis/custom-data-model-to-change-display-name
dmceachernmsft Jun 8, 2023
a3cfdbd
revert onFetchProfile in CallScreen.tsx
mgamis-msft Jun 12, 2023
ddef89f
Merge branch 'main' into mgamis/custom-data-model-to-change-display-name
mgamis-msft Jun 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions change-beta/@azure-communication-react-2f52c659-d28e-4e3c-9d1e-359cd3737b90.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "prerelease",
"comment": "Added onFetchProfile to CommonCallAdapterOptions to allow displayName changes when using AzureCommunicationCallAdapter",
"packageName": "@azure/communication-react",
"email": "miguelgamis@microsoft.com",
"dependentChangeType": "patch"
}
7 changes: 7 additions & 0 deletions change-beta/@azure-communication-react-d411729c-7346-4493-9d6b-c7d02be035eb.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "prerelease",
"comment": "Added onFetchProfile to CommonCallAdapterOptions.",
"packageName": "@azure/communication-react",
"email": "miguelgamis@microsoft.com",
"dependentChangeType": "patch"
}
7 changes: 7 additions & 0 deletions change/@azure-communication-react-2f52c659-d28e-4e3c-9d1e-359cd3737b90.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "prerelease",
"comment": "Added onFetchProfile to CommonCallAdapterOptions to allow displayName changes when using AzureCommunicationCallAdapter",
"packageName": "@azure/communication-react",
"email": "miguelgamis@microsoft.com",
"dependentChangeType": "patch"
}
7 changes: 7 additions & 0 deletions change/@azure-communication-react-d411729c-7346-4493-9d6b-c7d02be035eb.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "prerelease",
"comment": "Added onFetchProfile to CommonCallAdapterOptions.",
"packageName": "@azure/communication-react",
"email": "miguelgamis@microsoft.com",
"dependentChangeType": "patch"
}
7 changes: 3 additions & 4 deletions packages/communication-react/review/beta/communication-react.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1600,6 +1600,7 @@ export interface CommonCallAdapter extends AdapterState<CallAdapterState>, Dispo
// @beta
export type CommonCallAdapterOptions = {
videoBackgroundImages?: VideoBackgroundImage[];
onFetchProfile?: OnFetchProfileCallback;
};

// @public
Expand Down Expand Up @@ -1960,7 +1961,7 @@ export const createStatefulChatClient: (args: StatefulChatClientArgs, options?:
export const createTeamsCallAdapter: ({ userId, credential, locator, options }: TeamsCallAdapterArgs) => Promise<TeamsCallAdapter>;

// @beta
export const createTeamsCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: TeamsCallAgent, locator: CallAdapterLocator, options?: TeamsAdapterOptions | undefined) => Promise<TeamsCallAdapter>;
export const createTeamsCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: TeamsCallAgent, locator: CallAdapterLocator, options?: CommonCallAdapterOptions | undefined) => Promise<TeamsCallAdapter>;

// @public
export interface CreateVideoStreamViewResult {
Expand Down Expand Up @@ -3411,9 +3412,7 @@ export interface SystemMessageCommon extends MessageCommon {
}

// @beta
export type TeamsAdapterOptions = {
onFetchProfile?: OnFetchProfileCallback;
} & CommonCallAdapterOptions;
export type TeamsAdapterOptions = CommonCallAdapterOptions;

// @beta
export interface TeamsCallAdapter extends CommonCallAdapter {
Expand Down
7 changes: 3 additions & 4 deletions packages/react-composites/review/beta/react-composites.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -988,6 +988,7 @@ export interface CommonCallAdapter extends AdapterState<CallAdapterState>, Dispo
// @beta
export type CommonCallAdapterOptions = {
videoBackgroundImages?: VideoBackgroundImage[];
onFetchProfile?: OnFetchProfileCallback;
};

// @public
Expand Down Expand Up @@ -1107,7 +1108,7 @@ export function createAzureCommunicationChatAdapterFromClient(chatClient: Statef
export const createTeamsCallAdapter: ({ userId, credential, locator, options }: TeamsCallAdapterArgs) => Promise<TeamsCallAdapter>;

// @beta
export const createTeamsCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: TeamsCallAgent, locator: CallAdapterLocator, options?: TeamsAdapterOptions | undefined) => Promise<TeamsCallAdapter>;
export const createTeamsCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: TeamsCallAgent, locator: CallAdapterLocator, options?: CommonCallAdapterOptions | undefined) => Promise<TeamsCallAdapter>;

// @beta
type CustomCallControlButtonCallback = (args: CustomCallControlButtonCallbackArgs) => CustomCallWithChatControlButtonProps;
Expand Down Expand Up @@ -1465,9 +1466,7 @@ export interface RemoteVideoTileMenuOptions {
export type SelectedVideoBackgroundEffect = VideoBackgroundNoEffect | VideoBackgroundBlurEffect | VideoBackgroundReplacementEffect;

// @beta
export type TeamsAdapterOptions = {
onFetchProfile?: OnFetchProfileCallback;
} & CommonCallAdapterOptions;
export type TeamsAdapterOptions = CommonCallAdapterOptions;

// @beta
export interface TeamsCallAdapter extends CommonCallAdapter {
Expand Down
15 changes: 7 additions & 8 deletions ...es/react-composites/src/composites/CallComposite/adapter/AzureCommunicationCallAdapter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1051,6 +1051,12 @@ export type CommonCallAdapterOptions = {
* Default set of background images for background image picker.
*/
videoBackgroundImages?: VideoBackgroundImage[];
/**
* 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;
Copy link
Copy Markdown
Member

@dmceachernmsft dmceachernmsft Jun 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this something that can be overridden for just normal users as well?

Copy link
Copy Markdown
Contributor Author

@mgamis-msft mgamis-msft Jun 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, you can override the display name for any user based on the userId.
image

};

/**
Expand Down Expand Up @@ -1098,14 +1104,7 @@ export type AzureCommunicationCallAdapterArgs = {
*
* @beta
*/
export 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;
} & CommonCallAdapterOptions;
export type TeamsAdapterOptions = CommonCallAdapterOptions;

/**
* Arguments for creating the Azure Communication Services implementation of {@link TeamsCallAdapter}.
Expand Down
2 changes: 1 addition & 1 deletion packages/react-composites/src/composites/CallComposite/adapter/OnFetchProfileCallback.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ export const createProfileStateModifier = (
const profile = await onFetchProfile(key, { displayName: originalParticipants[key].displayName });
if (profile?.displayName && originalParticipants[key].displayName !== profile?.displayName) {
cachedDisplayName[key] = profile?.displayName;
shouldNotifyUpdates = true;
}
shouldNotifyUpdates = true;
}
// notify update only when there is a change, which most likely will trigger modifier and setState again
shouldNotifyUpdates && notifyUpdate();
Comment thread
mgamis-msft marked this conversation as resolved.
Expand Down
⚡