Circuit JavaScript SDK

API Docs for version 1.3.1803

Item

Module: Circuit

Summary

Data object defining an item. Based on the type, the appropriate sub item is set. E.g. text, rtc, system.

Properties

attachments

Syntax

attachments

Attachment[]

Summary

Array of attachments in the conversation

convId

Syntax

convId

String

Summary

Conversation ID

creationTime

Syntax

creationTime

Number

Summary

Timestamp when item has been created

creatorId

Syntax

creatorId

String

Summary

ID of user that created this item

includeInUnreadCount

Syntax

includeInUnreadCount

Boolean

Summary

Whether item should count towards the unread counter

itemId

Syntax

itemId

String

Summary

Conversation Item ID

modificationTime

Syntax

modificationTime

Number

Summary

Timestamp when item has last been modified

rtc

Syntax

rtc

RTCItem

Summary

Present if type is RTC

system

Syntax

system

SystemItem

Summary

Present if type is SYSTEM

text

Syntax

text

TextItem

Summary

Present if type is TEXT

type

Syntax

type

ConversationItemType

Summary

Type of item