sdk (3 of 5)

no.kindly.chatsdk.chat.sdk.data.entity.attachment

AttachmentEventItem

data class

@Serializable
data class AttachmentEventItem(val id: String, val name: String, val type: String, val status: String, val sender: String, val storagePath: String?, val url: String?, val created: String?, val sizeKb: Int?)

Individual attachment item in attachment events. This contains the full attachment object data.

Member	Declaration	Description
AttachmentEventItem	constructor(id: String, name: String, type: String, status: String, sender: String, storagePath: String?, url: String?, created: String?, sizeKb: Int?)
created	@SerialName(value = "created") val created: String?
id	@SerialName(value = "id") val id: String
name	@SerialName(value = "name") val name: String
sender	@SerialName(value = "sender") val sender: String
sizeKb	@SerialName(value = "size_kb") val sizeKb: Int?
status	@SerialName(value = "status") val status: String
storagePath	@SerialName(value = "storage_path") val storagePath: String?
type	@SerialName(value = "type") val type: String
url	@SerialName(value = "url") val url: String?

no.kindly.chatsdk.chat.sdk.data.entity.attachment.data

FileAttachment

data class

data class FileAttachment(val url: String = "", val created: String?)

Member	Declaration	Description
FileAttachment	constructor(url: String = "", created: String?)
created	val created: String?
url	val url: String

no.kindly.chatsdk.chat.sdk.data.entity.attachment.request

Attachment

data class

@Serializable
data class Attachment(val sizeKb: Double, val name: String, val type: String, val status: String = "PROCESSING", val sender: String = "USER", val temporaryId: String)

Member	Declaration	Description
Attachment	constructor(sizeKb: Double, name: String, type: String, status: String = "PROCESSING", sender: String = "USER", temporaryId: String)
name	@SerialName(value = "name") val name: String
sender	@SerialName(value = "sender") val sender: String
sizeKb	@SerialName(value = "sizeKb") val sizeKb: Double
status	@SerialName(value = "status") val status: String
temporaryId	@SerialName(value = "temporary_id") val temporaryId: String
type	@SerialName(value = "type") val type: String

FormState

enum

@Serializable
enum FormState : Enum<FormState>

Member	Declaration	Description
ACTIVE	@SerialName(value = "ACTIVE") ACTIVE
SUBMITTED	@SerialName(value = "SUBMITTED") SUBMITTED
CANCELLED	@SerialName(value = "CANCELLED") CANCELLED
UNANSWERED	@SerialName(value = "UNANSWERED") UNANSWERED
ERRORED	@SerialName(value = "ERRORED") ERRORED
entries	val entries: EnumEntries<FormState>	Returns a representation of an immutable list of all enum entries, in the order they're declared. This method may be used to iterate over the enum entries.
valueOf	fun valueOf(value: String): FormState	Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) Throws - kotlin.IllegalArgumentException: if this enum type has no constant with the specified name
values	fun values(): Array<FormState>	Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.

ListAttachments

data class

@Serializable
data class ListAttachments(val attachments: List<Attachment>, val temporaryChatMessageId: String? = null)

Member	Declaration	Description
ListAttachments	constructor(attachments: List<Attachment>, temporaryChatMessageId: String? = null)
attachments	@SerialName(value = "attachments") val attachments: List<Attachment>
temporaryChatMessageId	@SerialName(value = "temporaryChatMessageId") val temporaryChatMessageId: String?

PusherAuthRequestDTO

data class

@Serializable
data class PusherAuthRequestDTO(val socketId: String, val channelName: String)

Member	Declaration	Description
PusherAuthRequestDTO	constructor(socketId: String, channelName: String)
channelName	@SerialName(value = "channel_name") val channelName: String
socketId	@SerialName(value = "socket_id") val socketId: String

SubmitFeedbackFeedbackRequest

data class

@Serializable
data class SubmitFeedbackFeedbackRequest(val id: String? = null, val languageCode: String, val ratingSystem: Int, val triggerType: TriggerTypeSDK, val index: Int, val rating: String, val sentiment: String, val buttonsChosen: List<String>, val freeformText: String?, val formTitle: String?)

Member	Declaration	Description
SubmitFeedbackFeedbackRequest	constructor(id: String? = null, languageCode: String, ratingSystem: Int, triggerType: TriggerTypeSDK, index: Int, rating: String, sentiment: String, buttonsChosen: List<String>, freeformText: String?, formTitle: String?)
buttonsChosen	@SerialName(value = "buttons_chosen") val buttonsChosen: List<String>
formTitle	@SerialName(value = "form_title") val formTitle: String?
freeformText	@SerialName(value = "freeform_text") val freeformText: String?
id	@SerialName(value = "id") val id: String?
index	@SerialName(value = "index") val index: Int
languageCode	@SerialName(value = "language_code") val languageCode: String
rating	@SerialName(value = "rating") val rating: String
ratingSystem	@SerialName(value = "rating_system") val ratingSystem: Int
sentiment	@SerialName(value = "sentiment") val sentiment: String
triggerType	@SerialName(value = "trigger_type") val triggerType: TriggerTypeSDK

SubmitFeedbackRequest

data class

@Serializable
data class SubmitFeedbackRequest(val feedback: SubmitFeedbackFeedbackRequest)

Member	Declaration	Description
SubmitFeedbackRequest	constructor(feedback: SubmitFeedbackFeedbackRequest)
feedback	@SerialName(value = "feedback") val feedback: SubmitFeedbackFeedbackRequest

SubmitFormRequest

data class

@Serializable
data class SubmitFormRequest(val submissionId: String, val context: Map<String, String>, val state: FormState)

Member	Declaration	Description
SubmitFormRequest	constructor(submissionId: String, context: Map<String, String>, state: FormState)
context	@SerialName(value = "context") val context: Map<String, String>
state	@SerialName(value = "state") val state: FormState
submissionId	@SerialName(value = "submission_id") val submissionId: String

no.kindly.chatsdk.chat.sdk.data.entity.attachment.response

AttachmentResponse

data class

@Serializable
data class AttachmentResponse(val name: String, val type: String, val status: String, val sender: String, val storagePath: String, val created: String? = null, val sizeKb: String, val url: String? = null, val id: String, val uploadUrl: String? = null)

Member	Declaration	Description
AttachmentResponse	constructor(name: String, type: String, status: String, sender: String, storagePath: String, created: String? = null, sizeKb: String, url: String? = null, id: String, uploadUrl: String? = null)
created	val created: String?
id	val id: String
name	val name: String
sender	val sender: String
sizeKb	@SerialName(value = "size_kb") val sizeKb: String
status	val status: String
storagePath	@SerialName(value = "storage_path") val storagePath: String
type	val type: String
uploadUrl	@SerialName(value = "upload_url") val uploadUrl: String?
url	val url: String?

AttachmentUploadContext

enum

enum AttachmentUploadContext : Enum<AttachmentUploadContext>

Member	Declaration	Description
FORM	FORM
BUTTON	BUTTON
INPUT_FIELD	INPUT_FIELD
entries	val entries: EnumEntries<AttachmentUploadContext>	Returns a representation of an immutable list of all enum entries, in the order they're declared. This method may be used to iterate over the enum entries.
valueOf	fun valueOf(value: String): AttachmentUploadContext	Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) Throws - kotlin.IllegalArgumentException: if this enum type has no constant with the specified name
values	fun values(): Array<AttachmentUploadContext>	Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.

ButtonAttachmentComplete

data class

@Serializable
data class ButtonAttachmentComplete(val attachmentIds: List<String>, val temporaryChatMessageId: String, val exchangeId: String)

Member	Declaration	Description
ButtonAttachmentComplete	constructor(attachmentIds: List<String>, temporaryChatMessageId: String, exchangeId: String)
attachmentIds	val attachmentIds: List<String>
exchangeId	val exchangeId: String
temporaryChatMessageId	val temporaryChatMessageId: String

CompleteAttachment

data class

@Serializable
data class CompleteAttachment(val attachmentIds: List<String>, val temporaryChatMessageId: String?, val exchangeId: String?, val chatMessageId: String?)

Member	Declaration	Description
CompleteAttachment	constructor(attachmentIds: List<String>, temporaryChatMessageId: String?, exchangeId: String?, chatMessageId: String?)
attachmentIds	val attachmentIds: List<String>
chatMessageId	val chatMessageId: String?
exchangeId	val exchangeId: String?
temporaryChatMessageId	val temporaryChatMessageId: String?

FormAttachmentComplete

data class

@Serializable
data class FormAttachmentComplete(val attachmentIds: List<String>, val chatMessageId: String)

Member	Declaration	Description
FormAttachmentComplete	constructor(attachmentIds: List<String>, chatMessageId: String)
attachmentIds	val attachmentIds: List<String>
chatMessageId	val chatMessageId: String

InputFieldAttachmentComplete

data class

@Serializable
data class InputFieldAttachmentComplete(val attachmentIds: List<String>, val temporaryChatMessageId: String, val exchangeId: String? = null)

Member	Declaration	Description
InputFieldAttachmentComplete	constructor(attachmentIds: List<String>, temporaryChatMessageId: String, exchangeId: String? = null)
attachmentIds	val attachmentIds: List<String>
exchangeId	val exchangeId: String?
temporaryChatMessageId	val temporaryChatMessageId: String

LatestMessageDTO

data class

@Serializable
data class LatestMessageDTO(val chatMessages: List<MessageData>, val takenOver: Boolean?, val requestedTakeover: Boolean?, val buttonClicks: List<ButtonDataSDK>, val attachments: List<AttachmentResponse>?, val supportsAttachments: Boolean?, val handoverQueuePosition: Int?, val handoverWaitTimeEstimate: Int?)

Member	Declaration	Description
LatestMessageDTO	constructor(chatMessages: List<MessageData>, takenOver: Boolean?, requestedTakeover: Boolean?, buttonClicks: List<ButtonDataSDK>, attachments: List<AttachmentResponse>?, supportsAttachments: Boolean?, handoverQueuePosition: Int?, handoverWaitTimeEstimate: Int?)
attachments	@SerialName(value = "attachments") val attachments: List<AttachmentResponse>?
buttonClicks	@SerialName(value = "buttonClicks") val buttonClicks: List<ButtonDataSDK>
chatMessages	@SerialName(value = "chatMessages") val chatMessages: List<MessageData>
handoverQueuePosition	@SerialName(value = "handoverQueuePosition") val handoverQueuePosition: Int?
handoverWaitTimeEstimate	@SerialName(value = "handoverWaitTimeEstimate") val handoverWaitTimeEstimate: Int?
requestedTakeover	@SerialName(value = "requestedTakeover") val requestedTakeover: Boolean?
supportsAttachments	@SerialName(value = "supports_attachment") val supportsAttachments: Boolean?
takenOver	@SerialName(value = "takenOver") val takenOver: Boolean?
toString	open override fun toString(): String

LatestMessageDTO.Companion

object

object Companion

Member	Declaration	Description
dateFormat	const val dateFormat: String

ListAttachmentResponse

data class

@Serializable
data class ListAttachmentResponse(val attachments: List<AttachmentResponse>)

Member	Declaration	Description
ListAttachmentResponse	constructor(attachments: List<AttachmentResponse>)
attachments	val attachments: List<AttachmentResponse>

PusherAuthResponseDTO

data class

@Serializable
data class PusherAuthResponseDTO(val auth: String)

Member	Declaration	Description
PusherAuthResponseDTO	constructor(auth: String)
auth	val auth: String

PusherSubscriptionSucceededDTO

data class

@Serializable
data class PusherSubscriptionSucceededDTO(val channel: String)

Member	Declaration	Description
PusherSubscriptionSucceededDTO	constructor(channel: String)
channel	val channel: String

SubmitFeedbackData

data class

@Serializable
data class SubmitFeedbackData(val id: String = "")

Member	Declaration	Description
SubmitFeedbackData	constructor(id: String = "")
id	@SerialName(value = "id") val id: String

SubmitFeedbackResponse

data class

@Serializable
data class SubmitFeedbackResponse(val data: SubmitFeedbackData)

Member	Declaration	Description
SubmitFeedbackResponse	constructor(data: SubmitFeedbackData)
data	@SerialName(value = "data") val data: SubmitFeedbackData
feedbackId	val feedbackId: String

SubmitFormResponse

data class

@Serializable
data class SubmitFormResponse(val formSubmissionId: String, val formId: String, val state: FormState, val updatedContext: UpdatedContext)

Member	Declaration	Description
SubmitFormResponse	constructor(formSubmissionId: String, formId: String, state: FormState, updatedContext: UpdatedContext)
formId	@SerialName(value = "form_id") val formId: String
formSubmissionId	@SerialName(value = "form_submission_id") val formSubmissionId: String
state	@SerialName(value = "state") val state: FormState
updatedContext	@SerialName(value = "updated_context") val updatedContext: UpdatedContext

toAttachment

function

fun AttachmentResponse.toAttachment(): Attachment

Converts AttachmentResponse to Attachment.

toMessage

function

fun Attachment.toMessage(chatMessageID: String): MessageDataSDK

UpdatedContext

data class

@Serializable(with = UpdatedContextSerializer::class)
data class UpdatedContext(val name: String = "", val organizationName: String = "", val dynamicContext: Map<String, String>)

Member	Declaration	Description
UpdatedContext	constructor(name: String = "", organizationName: String = "", dynamicContext: Map<String, String>)
dynamicContext	val dynamicContext: Map<String, String>
name	val name: String
organizationName	val organizationName: String

UpdatedContextSerializer

object

object UpdatedContextSerializer : KSerializer<UpdatedContext>

Member	Declaration	Description
descriptor	open override val descriptor: SerialDescriptor
deserialize	open override fun deserialize(decoder: Decoder): UpdatedContext
serialize	open override fun serialize(encoder: Encoder, value: UpdatedContext)

no.kindly.chatsdk.chat.sdk.data.entity.settings

ChangeLanguageButtonSDK

data class

@Serializable
data class ChangeLanguageButtonSDK(val en: String?, val nb: String?, val nn: String?, val sv: String?)

Member	Declaration	Description
ChangeLanguageButtonSDK	constructor(en: String?, nb: String?, nn: String?, sv: String?)
en	@SerialName(value = "en") val en: String?
nb	@SerialName(value = "nb") val nb: String?
nn	@SerialName(value = "nn") val nn: String?
sv	@SerialName(value = "sv") val sv: String?

ChangeLanguageTextSDK

class

@Serializable
class ChangeLanguageTextSDK(val en: String?, val nb: String?, val nn: String?, val sv: String?)

Member	Declaration	Description
ChangeLanguageTextSDK	constructor(en: String?, nb: String?, nn: String?, sv: String?)
en	@SerialName(value = "en") val en: String?
nb	@SerialName(value = "nb") val nb: String?
nn	@SerialName(value = "nn") val nn: String?
sv	@SerialName(value = "sv") val sv: String?

ChatBubbleDataSDK

data class

@Serializable
data class ChatBubbleDataSDK(val domains: List<String>?, val key: String?, val realtimeAnalytics: Boolean?, val heartbeatEnabled: Boolean?, val heartbeatTtlS: Int?, val iconAvatarImage: String?, val persistState: Boolean?, val persistStateLifespanSeconds: Int?, val autopopup: Boolean?, val autopopupTime: Int?, val keepOpen: Boolean?, val keepOpenMobile: Boolean?, val inputLimitEnabled: Boolean?, val inputLimit: Int?, val authPublicKey: String?)

Member	Declaration	Description
ChatBubbleDataSDK	constructor(domains: List<String>?, key: String?, realtimeAnalytics: Boolean?, heartbeatEnabled: Boolean?, heartbeatTtlS: Int?, iconAvatarImage: String?, persistState: Boolean?, persistStateLifespanSeconds: Int?, autopopup: Boolean?, autopopupTime: Int?, keepOpen: Boolean?, keepOpenMobile: Boolean?, inputLimitEnabled: Boolean?, inputLimit: Int?, authPublicKey: String?)
authPublicKey	@SerialName(value = "auth_public_key") val authPublicKey: String?
autopopup	val autopopup: Boolean?
autopopupTime	@SerialName(value = "autopopup_time") val autopopupTime: Int?
domains	val domains: List<String>?
heartbeatEnabled	@SerialName(value = "heartbeat_enabled") val heartbeatEnabled: Boolean?
heartbeatTtlS	@SerialName(value = "heartbeat_ttl_s") val heartbeatTtlS: Int?
iconAvatarImage	@SerialName(value = "icon_avatar_image") val iconAvatarImage: String?
inputLimit	@SerialName(value = "input_limit") val inputLimit: Int?
inputLimitEnabled	@SerialName(value = "input_limit_enabled") val inputLimitEnabled: Boolean?
keepOpen	@SerialName(value = "keep_open") val keepOpen: Boolean?
keepOpenMobile	@SerialName(value = "keep_open_mobile") val keepOpenMobile: Boolean?
key	val key: String?
persistState	@SerialName(value = "persist_state") val persistState: Boolean?
persistStateLifespanSeconds	@SerialName(value = "persist_state_lifespan_seconds") val persistStateLifespanSeconds: Int?
realtimeAnalytics	@SerialName(value = "realtime_analytics") val realtimeAnalytics: Boolean?

ComplianceSettingsForLanguageSDK

data class

@Serializable
data class ComplianceSettingsForLanguageSDK(val enabled: Boolean?, val requireAgreement: Boolean?, val descriptionTextHtml: String?, val buttonText: String?, val acceptanceText: String?, val revokePermissionText: String?, val accessRequestText: String?)

Member	Declaration	Description
ComplianceSettingsForLanguageSDK	constructor(enabled: Boolean?, requireAgreement: Boolean?, descriptionTextHtml: String?, buttonText: String?, acceptanceText: String?, revokePermissionText: String?, accessRequestText: String?)
acceptanceText	@SerialName(value = "acceptance_text") val acceptanceText: String?
accessRequestText	@SerialName(value = "access_request_text") val accessRequestText: String?
buttonText	@SerialName(value = "button_text") val buttonText: String?
descriptionTextHtml	@SerialName(value = "description_text_html") val descriptionTextHtml: String?
enabled	val enabled: Boolean?
requireAgreement	@SerialName(value = "require_agreement") val requireAgreement: Boolean?
revokePermissionText	@SerialName(value = "revoke_permission_text") val revokePermissionText: String?

ComplianceSettingsSDK

data class

@Serializable(with = ComplianceSettingsSDKSerializer::class)
data class ComplianceSettingsSDK(val languageSettings: Map<String, ComplianceSettingsForLanguageSDK>)

Member	Declaration	Description
ComplianceSettingsSDK	constructor(languageSettings: Map<String, ComplianceSettingsForLanguageSDK>)
languageSettings	val languageSettings: Map<String, ComplianceSettingsForLanguageSDK>

ComplianceSettingsSDKSerializer

object

object ComplianceSettingsSDKSerializer : KSerializer<ComplianceSettingsSDK>

Member	Declaration	Description
descriptor	open override val descriptor: SerialDescriptor
deserialize	open override fun deserialize(decoder: Decoder): ComplianceSettingsSDK
serialize	open override fun serialize(encoder: Encoder, value: ComplianceSettingsSDK)

DeleteButtonSDK

data class

@Serializable
data class DeleteButtonSDK(val en: String?, val nb: String?, val nn: String?, val sv: String?)

Member	Declaration	Description
DeleteButtonSDK	constructor(en: String?, nb: String?, nn: String?, sv: String?)
en	@SerialName(value = "en") val en: String?
nb	@SerialName(value = "nb") val nb: String?
nn	@SerialName(value = "nn") val nn: String?
sv	@SerialName(value = "sv") val sv: String?

DeleteTextSDK

data class

@Serializable
data class DeleteTextSDK(var en: String?, var nb: String?, var nn: String?, var sv: String?)

Member	Declaration	Description
DeleteTextSDK	constructor(en: String?, nb: String?, nn: String?, sv: String?)
en	@SerialName(value = "en") var en: String?
nb	@SerialName(value = "nb") var nb: String?
nn	@SerialName(value = "nn") var nn: String?
sv	@SerialName(value = "sv") var sv: String?

DownloadButtonSDK

data class

@Serializable
data class DownloadButtonSDK(val en: String?, val nb: String?, val nn: String?, val sv: String?)

Member	Declaration	Description
DownloadButtonSDK	constructor(en: String?, nb: String?, nn: String?, sv: String?)
en	@SerialName(value = "en") val en: String?
nb	@SerialName(value = "nb") val nb: String?
nn	@SerialName(value = "nn") val nn: String?
sv	@SerialName(value = "sv") val sv: String?