Structures

Data model representing a Channel

Holds model for a channel preferences

Holds model for a channel preferences menu

Holds model for a channel menu object

Holds model for a channel menu call to actions

Main Data Model for CAIConversation.

Data Model structure for messages returned by CAI platform

Undocumented

Context information for the bot

Standard message format returns by CAI platform Raw format parsed as-is from what the backend system returns

Undocumented

Undocumented

Undocumented

Undocumented

Holds the content for a specific UIModelData. Properties will be filled based on UIModelData type.

Undocumented

Used for Image & Video cards

Enum CAIError. Implement SAPError. Raised when something is wrong with our platform services.

CAI Service definition. Helps to connect to CAI services. By default, it will connect to Community tenant.

Casual Color Palette

Fiori Color Palette. Follows SAP Fiori Design Language.

Use this structure to create and implement your own custom theme. Check out Theme.Key enums to know what can be configured.

Undocumented

SwiftUI main view. Use this when you want a full screen out-of-the box view that contains:

• BannerView hidden by default that slides down to display any errors.
• ChatView
• InputBarView This view will apply the accent color defined in your theme.

Safe Area is ignored at the bottom so the InputBarView can extend and apply the background Blur Effect all the way.

To function properly, this view requires 2 @EnvironmentObject objects to be set:

• viewModel: MessagingViewModel
• themeManager: ThemeManager. Recommended to use ThemeManager.shared

Usage example:

AssistantView()
    .navigationBarTitle(Text("Chat"), displayMode: .inline) // if you are in navigation controller
    .environmentObject( MessagingViewModel(publisher:
                          CAIConversation(config: CAIServiceConfig(SAPURLSession(), <#backendURL#>),
                                          channel: "<#channelId#>",
                                          token: "<#channelToken#>") )
    .environmentObject(themeManager)

Renders a ScrollView with the list of messages provided by the MessagingViewModel

Slide down and up a banner view. There is no default background color.

Example of usage:

BannerView("Text to display")
      .onTapGesture {
          someError = nil
      }
}

SearchBar SwiftUI wrapper for rendering a TextField, magnifer icon and clear button while editing

A view drawing an animated 3 dots. Use TypingIndicatorData to customize it. The view comes with a default frame already set.

InputBar view. Wraps a TextView and Send button. Send will call MessagingViewModel.postMessage(text: String) Height of the TextView grows as user types longer text.

Type-erased container to be used when setting own QuickReply button style If you wish to create your own QuickReply button style, do so by conforming to ButtonStyle, put it into QuickReplyButtonStyleContainer and use Theme.Key enum quickReplyButtonStyle() to apply it.

## Example: define style

 public struct MyCustomQuickReplyButtonStyle: ButtonStyle {
     public func makeBody(configuration: MyCustomQuickReplyButtonStyle.Configuration) -> AnyView {

         return AnyView(
             configuration.label
                 .font(.body)
                 .lineLimit(1)
                 .padding(EdgeInsets(top: 10, leading: 16, bottom: 10, trailing: 16))
         )
     }
 }

Example: apply style

 Theme(name: "myCustomTheme", values: [
     .quickReplyButtonStyle: QuickReplyButtonStyleContainer(MyCustomQuickReplyButtonStyle())
 ])

QuickReply button style applied when using custom theme and no specific button style was provided

QuickReply button style applied when using Fiori theme

QuickReply button style applied when using Casual theme