chat-sdk-core/com.nice.cxonechat.state

Package-level declarations

Types

Link copied to clipboard
interface Configuration

The various options for how a channel is configured.

Link copied to clipboard
interface Connection

Definition of a data object, which is holding information relevant to the lifecycle of SDK connection to the backend.

Link copied to clipboard
interface Environment

Current SDK environment providing backend (remote) configuration. This can differ from region to region and permits connecting to your own running copy of the service.

Link copied to clipboard
interface FieldDefinition

Definition of a custom Field that is stored on the server.

Link copied to clipboard
typealias FieldDefinitionList = Sequence<FieldDefinition>

Type alias for a list of FieldDefinition.

Link copied to clipboard
interface HierarchyNode<T>

Node definition for general data tree.

Link copied to clipboard
interface SelectorNode

Details of each entry in the list.

Functions

Link copied to clipboard
fun FieldDefinitionList.checkRequired(values: Map<String, String>)

Check that all required fields in the list have a value specified in values

Link copied to clipboard
fun Sequence<SelectorNode>.contains(nodeId: String): Boolean

Test if a sequence of SelectorNode contains a given node id.

Link copied to clipboard
fun FieldDefinitionList.containsField(fieldId: String): Boolean

Test target FieldDefinitionList for a FieldDefinition with a matching fieldId.

Link copied to clipboard
fun <T> HierarchyNode<T>.lookup(nodeId: T): HierarchyNode<T>?

Search the hierarchy for the node with the given nodeId.

fun FieldDefinitionList.lookup(fieldId: String): FieldDefinition?

Search target FieldDefinitionList for a FieldDefinition item with the requested fieldId.

fun <T> Sequence<HierarchyNode<T>>.lookup(nodeId: T): HierarchyNode<T>?

Recursively search a list of hierarchy nodes for the node with the given nodeId.

fun Sequence<SelectorNode>.lookup(nodeId: String): SelectorNode?

Search a sequence of nodes for a matching node id.

Link copied to clipboard
fun FieldDefinitionList.validate(values: Map<String, String>)

Validate a map of proposed fieldId, value pairs against the target FieldDefinitionList.