API Docs for version 1.2.6900

Conversation

Module: Circuit

Summary

Data object defining a conversation.

Properties

avatar

Syntax

avatar

String

Summary

Avatar of group or community (40x40px). Returns default avatar if conversation has no avatar set.

avatarLarge

Syntax

avatarLarge

String

Summary

Large avatar of group or community (250x250px). Returns default avatar if conversation has no avatar set.

conversationAvatar

Syntax

conversationAvatar

ConversationAvatar

Summary

IDs for small and large conversation avatars

convId

Syntax

convId

String

Summary

Conversation ID

creationTime

Syntax

creationTime

Number

Summary

Timestamp of conversation creation

creatorId

Syntax

creatorId

String

Summary

User ID of user that created this conversation

creatorTenantId

Syntax

creatorTenantId

String

Summary

Tenant ID for user that created the conversation

description

Syntax

description

String

Summary

Conversation description. Only applicable to communities.

hasConversationAvatar

Syntax

hasConversationAvatar

Boolean

Summary

true if conversation has a custom avatar

isGuestAccessDisabled

Syntax

isGuestAccessDisabled

Boolean

Summary

True if guest access is disabled

isModerated

Syntax

isModerated

Boolean

Summary

True if conversation is moderated

isSupportConversation

Syntax

isSupportConversation

Bool

Summary

True for the dedicated support conversation.

isTelephonyConversation

Syntax

isTelephonyConversation

Bool

Summary

True for the dedicated telephony conversation.

modificationTime

Syntax

modificationTime

Number

Summary

Timestamp of last conversation modification

participants

Syntax

participants

String[]

Summary

Array of participant user IDs

topic

Syntax

topic

String

Summary

Topic (only applicable for group and communities).

topLevelItem

Syntax

topLevelItem

Item

Summary

Most recent conversation item that qualifies as 'important'

type

Syntax

Summary

Conversation type

userData

Syntax

Summary

User specific data such as unread information.