Model: Group

Back to overview

Model Fields

Field Description Type Optional Nullable Default
id

The group identity

String False False
name

The group name (max 256 bytes)

String True False
displayName

The group display name

String False False
color

The group color in hex notation (e.g. "#1122FF")

String False False
createdAt

The group creation date as a unix time stamp in seconds

Integer False False
disabled

This is set to true if the user is not a member of this group anymore

Boolean True False False
locked

This is set to true if the chat is marked as a secret chat

Boolean True False False
visible

This is set to false if the chat is marked as a secret chat and if secret chats are hidden in the app

Boolean True False True
members

The list of group member identities

Array<String> False False
administrator

The identity of the group admin

String False False
access

The access object

Map<GroupReceiverAccess> False False