API Docs for version 1.2.6401

SystemItem

Module: Circuit

Summary

Data object defining an Item of type SYSTEM. E.g. when a participant is added to a conversation.

Item Index

Properties

addParticipant

Syntax

addParticipant

Object

Summary

Detailed information for one or more added participants. Used for example for the case a direct conversation is upgraded to a group conversation.

affectedParticipants

Syntax

affectedParticipants

Object[]

Summary

The list of user IDs which are affected by this system item, e.g. the participant that were added or the participant that has created a conversation. At this time the user IDs are wrapped in an object, hence the type Object[]. This might change in the near future to just be an arary of User IDs.

type

Syntax

Summary

Type of system item.