Work with Channels

Use the Channel class for working with conversations between two or more users.

Represents information about a workspace channel.

Usage

See Slack's channel object type.

Channel Methods

The following are methods for Channel.

getCreated()

Signature

Return Value

Type: Integer

getCreator()

Signature

Return Value

Type: String

getEnterpriseId()

Signature

Return Value

Type: String

getId()

Signature

Return Value

Type: String

getIsMoved()

Signature

Return Value

Type: Integer

getLastRead()

Signature

Return Value

Type: String

getLatest()

Signature

Return Value

Type: Slack.Latest

getMembers()

Signature

Return Value

Type: List<String>

getName()

Signature

Return Value

Type: String

getNameNormalized()

Signature

Return Value

Type: String

getNumMembers()

Signature

Return Value

Type: Integer

getPendingShared()

Signature

Return Value

Type: List<String>

getPreviousNames()

Signature

Return Value

Type: List<String>

getPriority()

Signature

Return Value

Type: Double

getPurpose()

Signature

Return Value

Type: Slack.Purpose

getTopic()

Signature

Return Value

Type: Slack.Topic

getUnlinked()

Signature

Return Value

Type: Integer

getUnreadCount()

Signature

Return Value

Type: Integer

getUnreadCountDisplay()

Signature

Return Value

Type: Integer

getUser()

Signature

Return Value

Type: String

isArchived()

Signature

Return Value

Type: Boolean

isChannel()

Signature

Return Value

Type: Boolean

isExtShared()

Signature

Return Value

Type: Boolean

isGeneral()

Signature

Return Value

Type: Boolean

isGlobalShared()

Signature

Return Value

Type: Boolean

isGroup()

Signature

Return Value

Type: Boolean

isIm()

Signature

Return Value

Type: Boolean

isMember()

Signature

Return Value

Type: Boolean

isMpim()

Returns true for a private channel or a group DM channel.

Signature

Return Value

Type: Boolean

isOrgDefault()

Signature

Return Value

Type: Boolean

isOrgMandatory()

Signature

Return Value

Type: Boolean

isOrgShared()

Signature

Return Value

Type: Boolean

isPendingExtShared()

Signature

Return Value

Type: Boolean

isPrivateChannel()

Signature

Return Value

Type: Boolean

isReadOnly()

Signature

Return Value

Type: Boolean

isShared()

Signature

Return Value

Type: Boolean

isThreadOnly()

Signature

Return Value

Type: Boolean

setArchived(archived)

Signature

Parameters

archived

Type: Boolean

Return Value

Type: void

setChannel(channel)

Signature

Parameters

channel

Type: Boolean

Return Value

Type: void

setCreated(created)

Signature

Parameters

created

Type: Integer

Return Value

Type: void

setCreator(creator)

Signature

Parameters

creator

Type: String

Return Value

Type: void

setEnterpriseId(enterpriseId)

Signature

Parameters

enterpriseId

Type: String

Return Value

Type: void

setExtShared(extShared)

Signature

Parameters

extShared

Type: Boolean

Return Value

Type: void

setGeneral(general)

Signature

Parameters

general

Type: Boolean

Return Value

Type: void

setGlobalShared(globalShared)

Signature

Parameters

globalShared

Type: Boolean

Return Value

Type: vpod

setGroup(groupValue)

Signature

Parameters

groupValue

Type: Boolean

Return Value

Type: void

setId(id)

Signature

Parameters

id

Type: String

Return Value

Type: void

setIm(im)

Signature

Parameters

im

Type: Boolean

Return Value

Type: void

setIsMoved(isMoved)

Signature

Parameters

isMoved

Type: Integer

Return Value

Type: void

setLastRead(lastRead)

Signature

Parameters

lastRead

Type: String

Return Value

Type: void

setLatest(latest)

Signature

Parameters

latest

Type: Slack.Latest

Return Value

Type: void

setMember(member)

Signature

Parameters

member

Type: Boolean

Return Value

Type: void

setMembers(members)

Signature

Parameters

members

Type: List<String>

Return Value

Type: void

setMpim(mpim)

Signature

Parameters

mpim

Type: Boolean

Return Value

Type: void

setName(name)

Signature

Parameters

name

Type: String

Return Value

Type: void

setNameNormalized(nameNormalized)

Signature

Parameters

nameNormalized

Type: String

Return Value

Type: void

setNumMembers(numMembers)

Signature

Parameters

numMembers

Type: Integer

Return Value

Type: void

setOrgDefault(orgDefault)

Signature

Parameters

orgDefault

Type: Boolean

Return Value

Type: void

setOrgMandatory(orgMandatory)

Signature

Parameters

orgMandatory

Type: Boolean

Return Value

Type: void

setOrgShared(orgShared)

Signature

Parameters

orgShared

Type: Boolean

Return Value

Type: void

setPendingExtShared(pendingExtShared)

Signature

Parameters

pendingExtShared

Type: Boolean

Return Value

Type: void

setPendingShared(pendingShared)

Signature

Parameters

pendingShared

Type: List<String>

Return Value

Type: void

setPreviousNames(previousNames)

Signature

Parameters

previousNames

Type: List<String>

Return Value

Type: void

setPriority(priority)

Signature

Parameters

priority

Type: Double

Return Value

Type: void

setPrivateChannel(privateChannel)

Signature

Parameters

privateChannel

Type: Boolean

Return Value

Type: void

setPurpose(purpose)

Signature

Parameters

purpose

Type: Slack.Purpose

Return Value

Type: void

setReadOnly(readOnly)

Signature

Parameters

readOnly

Type: Boolean

Return Value

Type: void

setShared(shared)

Signature

Parameters

shared

Type: Boolean

Return Value

Type: void

setThreadOnly(threadOnly)

Signature

Parameters

threadOnly

Type: Boolean

Return Value

Type: void

setTopic(topic)

Signature

Parameters

topic

Type: Slack.Topic

Return Value

Type: void

setUnlinked(unlinked)

Signature

Parameters

unlinked

Type: Integer

Return Value

Type: void

setUnreadCount(unreadCount)

Signature

Parameters

unreadCount

Type: Integer

Return Value

Type: void

setUnreadCountDisplay(unreadCountDisplay)

Signature

Parameters

unreadCountDisplay

Type: Integer

Return Value

Type: void

setUser(user)

Signature

Parameters

user

Type: String

Return Value

Type: void