Skip to content

Commit f31436c

Browse files
authored
Update android.md
1 parent 9d1ea9e commit f31436c

File tree

1 file changed

+9
-9
lines changed
  • articles/communication-services/how-tos/ui-library-sdk/includes/data-model

1 file changed

+9
-9
lines changed

articles/communication-services/how-tos/ui-library-sdk/includes/data-model/android.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,28 +18,28 @@ The UI Library gives developers the ability to provide a more customized experie
1818

1919
#### Local Participant View Data
2020

21-
`ParticipantViewData` is a class that set the `renderedDisplayName`, `avatarBitmap` and `scaleType` for avatar control. This class is passed to the configuration in order to customize the local participants view information.
21+
`CallCompositeParticipantViewData` is a class that set the `displayName`, `avatarBitmap` and `scaleType` for avatar control. This class is passed to the `CallCompositeLocalOptions` in order to customize the local participants view information.
2222

23-
This class is held in the `LocalSettings` object that represents options used locally on the device making the call.
23+
This class is held in the `CallCompositeLocalOptions` object that represents options used locally on the device making the call.
2424

25-
`renderedDisplayName` differs from the `displayName` passed in via the `TeamsMeetingOptions` and `GroupCallOptions` in that it is only used locally as an override, where `displayName` is passed to the server and shared with other participants. When `renderedDisplayName` is not provided, `displayName` is used.
25+
`displayName` differs from the `displayName` passed in via the `CallCompositeRemoteOptions`. `CallCompositeParticipantViewData` `displayName` is only used locally as an override, where `CallCompositeRemoteOptions` `displayName` is passed to the server and shared with other participants. When `CallCompositeParticipantViewData` `displayName` is not provided, `CallCompositeRemoteOptions` `displayName` is used.
2626

2727
#### Usage
2828

29-
To use the `LocalSettings`, pass the instance of `CallCompositeParticipantViewData` and inject `LocalSettings` to `callComposite.launch`.
29+
To use the `CallCompositeLocalOptions`, pass the instance of `CallCompositeParticipantViewData` and inject `CallCompositeLocalOptions` to `callComposite.launch`.
3030

3131
#### [Kotlin](#tab/kotlin)
3232

3333
```kotlin
34-
val viewData = CallCompositeParticipantViewData("LocalUserDisplayName") // bitmap is optional
34+
val viewData = CallCompositeParticipantViewData().setDisplayName("displayName") // setAvatarBitmap for bitmap
3535
val localOptions = CallCompositeLocalOptions(viewData)
3636
callComposite.launch(this, remoteOptions, localOptions)
3737
```
3838

3939
#### [Java](#tab/java)
4040

4141
```java
42-
ParticipantViewData viewData = new CallCompositeParticipantViewData("LocalUserDisplayName", bitmap); // bitmap is optional
42+
CallCompositeParticipantViewData viewData = new CallCompositeParticipantViewData().setDisplayName("displayName"); // setAvatarBitmap for bitmap
4343
CallCompositeLocalOptions localOptions = new CallCompositeLocalOptions(viewData);
4444
callComposite.launch(this, remoteOptions, localOptions);
4545
```
@@ -53,7 +53,7 @@ callComposite.launch(this, remoteOptions, localOptions);
5353

5454
In some instances, you may wish to provide local overrides for remote participants to allow custom avatars and titles.
5555

56-
The process is similar to the local participant process, however the data is set when participants join the call. As a developer you would need to add a listener to when remote participants join the call, and then call a method to set the ParticipantViewData for that remote user.
56+
The process is similar to the local participant process, however the data is set when participants join the call. As a developer you would need to add a listener to when remote participants join the call, and then call a method to set the `CallCompositeParticipantViewData` for that remote user.
5757

5858
#### Usage
5959

@@ -71,7 +71,7 @@ callComposite.setOnRemoteParticipantJoinedHandler { remoteParticipantJoinedEvent
7171
remoteParticipantJoinedEvent.identifiers.forEach { identifier ->
7272
// get displayName, bitmap for identifier
7373
callComposite.setRemoteParticipantViewData(identifier,
74-
ParticipantViewData("display_name"))
74+
CallCompositeParticipantViewData().setDisplayName("displayName")) // setAvatarBitmap for bitmap
7575
}
7676
}
7777
```
@@ -83,7 +83,7 @@ callComposite.setOnRemoteParticipantJoinedHandler { remoteParticipantJoinedEvent
8383
for (CommunicationIdentifier identifier: remoteParticipantJoinedEvent.getIdentifiers()) {
8484
// get displayName, bitmap for identifier
8585
callComposite.setRemoteParticipantViewData(identifier,
86-
new ParticipantViewData("display_name"));
86+
new CallCompositeParticipantViewData().setDisplayName("displayName")); // setAvatarBitmap for bitmap
8787
}
8888
});
8989
```

0 commit comments

Comments
 (0)