Home / @sym20/core-chat

core-chat package

This package provides APIs to access Symphony Chat UI Services and Chat Overlay views.

Remarks

This package provides a set of APIs to add UI components through a set of UI extension points in the chat application. Each extension point is related to a specfic conversation.

Overlays

An extension can provide an overlay component that will be rendered in the chat application. The overlay component will be connected to a specific conversation, and the extension can choose where in the chat the overlay component should be rendered.

Enumerations

EnumerationDescription
DockingMode

Enum that determines how an IOverlayView is displayed within the chat view.

Interfaces

InterfaceDescription
IChatService

Service module for conversations

IOverlayView

View that will be displayed inside a container view

The view can choose how to be docked to the container view, or to completely cover the container view.

See DockingMode for details on how to position a view in different docking modes.

Namespaces

NamespaceDescription
IChatService

Types

Type AliasDescription
OverlayFactory

Function to create overlay views for a specific chat view.

The function will be invoked whenever a chat view is created, to give the opportunity to add zero or more overlay views to the chat.