UserGroup

@Immutable

data class UserGroup(val id: String, val name: String, val description: String? = null, val team: String = "", val members: List<UserGroupMember> = emptyList(), val createdBy: String? = null, val createdAt: Date? = null, val updatedAt: Date? = null)

Named collection of users that can be mentioned together with @<name>.

Unique identifier of the group within an app (or team, when multi-tenancy is enabled).

name

Display name; the literal that follows @ in message text.

description

Optional description.

team

Team this group is scoped to, when multi-tenancy is enabled. Empty when not.

members

Group members. May be empty when the group object only carries metadata.

createdBy

User ID of the creator, when known.

createdAt

When the group was created.

updatedAt

Last time the group's metadata changed.

Constructors

constructor(id: String, name: String, description: String? = null, team: String = "", members: List<UserGroupMember> = emptyList(), createdBy: String? = null, createdAt: Date? = null, updatedAt: Date? = null)