You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/communication-services/how-tos/ui-library-sdk/includes/data-model/ios.md
+12-4Lines changed: 12 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,25 +16,33 @@ The UI Library now gives developers the ability to provide a more customized exp
16
16
17
17
#### Local Options
18
18
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.
20
22
21
23
#### Participant View Data
22
24
23
25
`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.
24
26
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
+
25
32
#### Usage
26
33
27
34
```swift
28
35
// LocalOptions (data not sent to server)
29
36
let localParticipantViewData =ParticipantViewData(avatar: <Some UIImage>,
30
37
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)
33
42
// RemoteOptions (data sent to server)
34
43
let remoteOptions =RemoteOptions(for: .groupCall(groupId: UUID()),
0 commit comments