Skip to content

Commit 5f713bf

Browse files
Merge pull request #210316 from jpeng-ms/patch-2
added SetupScreenViewData info for 1.1.0 release
2 parents aa9a3c0 + b3dd98f commit 5f713bf

File tree

2 files changed

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

2 files changed

+13
-5
lines changed

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

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,33 @@ 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 can have `ParticipantViewData` that will represent the local participant. By default, 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 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.
20+
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.
2022

2123
#### Participant View Data
2224

2325
`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.
2426

27+
#### Setup Screen View Data
28+
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.
31+
2532
#### Usage
2633

2734
```swift
2835
// LocalOptions (data not sent to server)
2936
let localParticipantViewData = ParticipantViewData(avatar: <Some UIImage>,
3037
displayName: "<DISPLAY_NAME>")
31-
let localOptions = LocalOptions(participantViewData: localParticipantViewData)
32-
38+
let localSetupScreenViewData = SetupScreenViewData(title: "<NAV_TITLE>",
39+
subtitle: "<NAV_SUBTITLE>")
40+
let localOptions = LocalOptions(participantViewData: localParticipantViewData,
41+
setupScreenViewData: localSetupScreenViewData)
3342
// RemoteOptions (data sent to server)
3443
let remoteOptions = RemoteOptions(for: .groupCall(groupId: UUID()),
3544
credential: <Some CommunicationTokenCredential>,
3645
displayName: "<DISPLAY_NAME>")
37-
3846
// Launch
3947
callComposite.launch(remoteOptions: remoteOptions, localOptions: localOptions)
4048
```

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ In Xcode, create a new project:
4848

4949
target 'UILibraryQuickStart' do
5050
use_frameworks!
51-
pod 'AzureCommunicationUICalling', '1.0.0'
51+
pod 'AzureCommunicationUICalling', '1.1.0'
5252
end
5353
```
5454

0 commit comments

Comments
 (0)