Skip to content

Commit a0c98dc

Browse files
Merge pull request #232536 from vhuseinova-msft/main
AzureCommunicationUIChat version update and CallComposite sample memory leak fix
2 parents 6bfe094 + c0eeb71 commit a0c98dc

File tree

2 files changed

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

2 files changed

+9
-9
lines changed

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,18 @@ The UI Library now gives developers the ability to provide a more customized exp
1616

1717
#### Local Options
1818

19-
`LocalOptions` is data model that consists of `ParticipantViewData` and `SetupScreenViewData`. By default for `ParticipantViewData`, the UI library will display the `displayName` injected in `RemoteOptions` that is sent to Azure Communication Service backend server. If `ParticipantViewData` is injected, the participant `displayName` and `avatar` will be displayed in all avatar components.
19+
`LocalOptions` is data model that consists of `ParticipantViewData` and `SetupScreenViewData`. By default for `ParticipantViewData`, the UI library displays the `displayName` injected in `RemoteOptions` that is sent to Azure Communication Service backend server. If `ParticipantViewData` is injected, the participant `displayName` and `avatar` will be displayed in all avatar components.
2020

21-
Similarly, for 'SetupScreenViewData', by default the UI library will display 'Setup' as the title and subtitle will be set to hidden. The `title` and `subtitle` in 'SetupScreenViewData' would overwrite the navigation bar's title and subtitle in pre-meeting screen respectively.
21+
Similarly, for 'SetupScreenViewData', by default the UI library displays 'Setup' as the title and subtitle is set to hidden. The `title` and `subtitle` in 'SetupScreenViewData' would overwrite the navigation bar's title and subtitle in pre-meeting screen respectively.
2222

2323
#### Participant View Data
2424

2525
`ParticipantViewData` is an object that sets the `displayName` and `avatar` UIImage for avatar components. This class is injected into the UI Library to set avatar information, and it will always be locally stored and never sent up to the server.
2626

2727
#### Setup Screen View Data
2828

29-
`SetupScreenViewData` is an object that sets the `title` and `subtitle` for the navigationBar on pre-meeting screen (aka. Setup View). If `SetupScreenViewData` is defined, then 'title' must be provided as it's a required field. 'subtitle', however, is not required.
30-
If `subtitle` is not defined, then the subtitle would always be set to hidden. This class is locally stored and its information will not be sent up to the server.
29+
`SetupScreenViewData` is an object that sets the `title` and `subtitle` for the navigationBar on pre-meeting screen (also known as Setup View). If `SetupScreenViewData` is defined, then 'title' must be provided as it's a required field. 'subtitle', however, isn't required.
30+
If `subtitle` isn't defined, then the subtitle would always be set to hidden. This class is locally stored and its information won't be sent up to the server.
3131

3232
#### Usage
3333

@@ -60,12 +60,12 @@ On remote participant join, developers can inject the participant view data for
6060
To set the participant view data for remote participant, set `onRemoteParticipantJoined` completion for events handler. On remote participant join, use `CallComposite` `set(remoteParticipantViewData:, for:, completionHandler:)` to inject view data for remote participant. The participant identifier `CommunicationIdentifier` is used to uniquely identify a remote participant. The optional completion handler is used for returning result of the set operation.
6161

6262
```swift
63-
callComposite.events.onRemoteParticipantJoined = { identifiers in
63+
callComposite.events.onRemoteParticipantJoined = { [weak callComposite] identifiers in
6464
for identifier in identifiers {
6565
// map identifier to displayName
6666
let participantViewData = ParticipantViewData(displayName: "<DISPLAY_NAME>")
67-
callComposite.set(remoteParticipantViewData: participantViewData,
68-
for: identifier) { result in
67+
callComposite?.set(remoteParticipantViewData: participantViewData,
68+
for: identifier) { result in
6969
switch result {
7070
case .success:
7171
print("Set participant view data succeeded")

articles/communication-services/quickstarts/ui-library/includes/get-started-chat/ios.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,13 @@ In Xcode, create a new project:
4949

5050
target 'UILibraryQuickStart' do
5151
use_frameworks!
52-
pod 'AzureCommunicationUIChat', '1.0.0-beta2'
52+
pod 'AzureCommunicationUIChat', '1.0.0-beta.3'
5353
end
5454
```
5555

5656
1. Run `pod install --repo-update`.
5757

58-
1. In Xcode, open the generated *.xcworkspace* file.
58+
1. In Xcode, open the generated *xcworkspace* file.
5959

6060
### Turn off Bitcode
6161

0 commit comments

Comments
 (0)