Skip to main content

ChatChannel

A type representing a chat channel. ChatChannel is an immutable snapshot of a channel entity at the given time.

public struct ChatChannel

Inheritance​

Hashable

Properties​

cid​

The ChannelId of the channel.

public let cid: ChannelId

name​

Name for this channel.

public let name: String?

imageURL​

Image (avatar) URL for this channel.

public let imageURL: URL?

lastMessageAt​

The date of the last message in the channel.

public let lastMessageAt: Date?

createdAt​

The date when the channel was created.

public let createdAt: Date

updatedAt​

The date when the channel was updated.

public let updatedAt: Date

deletedAt​

If the channel was deleted, this field contains the date of the deletion.

public let deletedAt: Date?

createdBy​

The user which created the channel.

public let createdBy: ChatUser?

config​

A configuration struct of the channel. It contains additional information about the channel settings.

public let config: ChannelConfig

isFrozen​

Returns true if the channel is frozen.

public let isFrozen: Bool

It's not possible to send new messages to a frozen channel.

memberCount​

The total number of members in the channel.

public let memberCount: Int

lastActiveMembers​

A list of members of this channel.

public var lastActiveMembers: [ChatChannelMember]

Array is sorted and the most recently active members will be first.

currentlyTypingUsers​

A list of currently typing users.

public var currentlyTypingUsers: Set<ChatUser>

membership​

If the current user is a member of the channel, this variable contains the details about the membership.

public let membership: ChatChannelMember?

lastActiveWatchers​

A list of users and/or channel members currently actively watching the channel.

public var lastActiveWatchers: [ChatUser]

Array is sorted and the most recently active watchers will be first.

watcherCount​

The total number of online members watching this channel.

public let watcherCount: Int

team​

The team the channel belongs to.

public let team: TeamId?

You need to enable multi-tenancy if you want to use this, else it'll be nil. Refer to docs for more info.

unreadCount​

The unread counts for the channel.

public var unreadCount: ChannelUnreadCount

latestMessages​

An option to enable ban users. Latest messages present on the channel.

public var latestMessages: [ChatMessage]

This field contains only the latest messages of the channel. You can get all existing messages in the channel by creating and using a ChatChannelController for this channel id.

pinnedMessages​

Pinned messages present on the channel.

public var pinnedMessages: [ChatMessage]

This field contains only the pinned messages of the channel. You can get all existing messages in the channel by creating and using a ChatChannelController for this channel id.

reads​

Read states of the users for this channel.

public let reads: [ChatChannelRead]

You can use this information to show to your users information about what messages were read by certain users.

muteDetails​

Channel mute details. If nil the channel is not muted by the current user.

public var muteDetails: MuteDetails?

isMuted​

Says whether the channel is muted by the current user.

public var isMuted: Bool

cooldownDuration​

Cooldown duration for the channel, if it's in slow mode. This value will be 0 if the channel is not in slow mode. This value is in seconds. For more information, please check documentation.

public let cooldownDuration: Int

extraData​

Additional data associated with the channel.

public let extraData: [String: RawJSON]

type​

The type of the channel.

public var type: ChannelType

isDeleted​

Returns true if the channel was deleted.

public var isDeleted: Bool

isDirectMessageChannel​

Checks if read events evadable for the current user. Returns true when the channel is a direct-message channel. A "direct message" channel is created when client sends only the user id's for the channel and not an explicit cid, so backend creates a cid based on member's ids

public var isDirectMessageChannel: Bool

isUnread​

returns true if the channel has one or more unread messages for the current user.

public var isUnread: Bool

Methods​

hash(into:)​

public func hash(into hasher: inout Hasher)

Operators​

==

public static func == (lhs: ChatChannel, rhs: ChatChannel) -> Bool

Did you find this page helpful?