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

Package-level declarations

Types

Configuration

interface Configuration

The various options for how a channel is configured.

Connection

interface Connection

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

Environment

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.

FieldDefinition

interface FieldDefinition

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

FieldDefinitionList

typealias FieldDefinitionList = Sequence<FieldDefinition>

Type alias for a list of FieldDefinition.

FileRestrictions

interface FileRestrictions

Restrictions to be enforced on uploaded attachments.

HierarchyNode

interface HierarchyNode<T>

Node definition for general data tree.

SelectorNode

interface SelectorNode

Details of each entry in the list.

Functions

checkRequired

fun FieldDefinitionList.checkRequired(values: Map<String, String>)

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

contains

fun Sequence<SelectorNode>.contains(nodeId: String): Boolean

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

containsField

fun FieldDefinitionList.containsField(fieldId: String): Boolean

Test target FieldDefinitionList for a FieldDefinition with a matching fieldId.

lookup

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.

validate

fun FieldDefinitionList.validate(values: Map<String, String>)

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