Skip to main content

ChatChannel

A chat channel that people can join.

type ChatChannel {
conversation: ChatConversation
createdAt: DateTime!
createdBy: String!
creator: User
description: String
id: ID!
isDefault: Boolean!
isPrivate: Boolean!
memberCount: Int
members: [ChatChannelMember!]
name: String!
organizationId: String!
updatedAt: DateTime!
}

Fields​

ChatChannel.conversation ● ChatConversation object​

The conversation held in the channel.

ChatChannel.createdAt ● DateTime! non-null scalar​

When the record was created.

ChatChannel.createdBy ● String! non-null scalar​

The ID of the user who created the channel.

ChatChannel.creator ● User object​

The user who created the channel.

ChatChannel.description ● String scalar​

What the channel is for.

ChatChannel.id ● ID! non-null scalar​

The unique ID of this record.

ChatChannel.isDefault ● Boolean! non-null scalar​

Whether this is the default.

ChatChannel.isPrivate ● Boolean! non-null scalar​

True when only invited people can join.

ChatChannel.memberCount ● Int scalar​

How many members the channel has.

ChatChannel.members ● [ChatChannelMember!] list object​

The members of the channel.

ChatChannel.name ● String! non-null scalar​

The name of the channel.

ChatChannel.organizationId ● String! non-null scalar​

The ID of the organization the record belongs to.

ChatChannel.updatedAt ● DateTime! non-null scalar​

When the record was last changed.

Returned By​

addChannelMembers mutation ● chatChannel query ● chatChannels query ● createChatChannel mutation ● removeChannelMember mutation ● updateChatChannel mutation

Member Of​

ChatChannelMember object