Slack v0.2.1 Slack.Channel View Source
A publicly listed communication channel in a team
Link to this section Summary
Functions
Archive a channel.
Create a channel.
Retrieve channel history.
Get channel info.
Invite a user to a channel.
Join a channel.
Kick a user from a channel.
Leave a channel.
List all of the channels in a team.
Move the read cursor in a channel.
Rename a channel.
Set the purpose of a channel.
Set the topic of a channel.
Unarchive a channel.
Link to this section Functions
archive(client, body \\ [])
View Sourcearchive(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Archive a channel.
https://api.slack.com/methods/channels.archive
Examples
Slack.client(token)
|> Slack.Channel.archive(channel: "C1234567890")
create(client, body \\ [])
View Sourcecreate(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Create a channel.
https://api.slack.com/methods/channels.create
Examples
Slack.client(token)
|> Slack.Channel.create(name: "mychannel")
history(client, query \\ [])
View Sourcehistory(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Retrieve channel history.
https://api.slack.com/methods/channels.history
Examples
Slack.client(token)
|> Slack.Channel.history(channel: "C1234567890")
info(client, query \\ [])
View Sourceinfo(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Get channel info.
https://api.slack.com/methods/channels.info
Examples
Slack.client(token)
|> Slack.Channel.info(channel: "C1234567890")
invite(client, body \\ [])
View Sourceinvite(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Invite a user to a channel.
https://api.slack.com/methods/channels.invite
Examples
Slack.client(token)
|> Slack.Channel.invite(channel: "C1234567890", user: "U1234567890")
join(client, body \\ [])
View Sourcejoin(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Join a channel.
https://api.slack.com/methods/channels.join
Examples
Slack.client(token)
|> Slack.Channel.join(channel: "C1234567890")
kick(client, body \\ [])
View Sourcekick(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Kick a user from a channel.
https://api.slack.com/methods/channels.kick
Examples
Slack.client(token)
|> Slack.Channel.kick(channel: "C1234567890", user: "U1234567890")
leave(client, body \\ [])
View Sourceleave(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Leave a channel.
https://api.slack.com/methods/channels.leave
Examples
Slack.client(token)
|> Slack.Channel.leave(channel: "C1234567890")
list(client, query \\ [])
View Sourcelist(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
List all of the channels in a team.
https://api.slack.com/methods/channels.list
Examples
Slack.client(token)
|> Slack.Channel.list
mark(client, body \\ [])
View Sourcemark(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Move the read cursor in a channel.
https://api.slack.com/methods/channels.mark
Examples
Slack.client(token)
|> Slack.Channel.mark(channel: "C1234567890", ts: "1234567890.123456")
rename(client, body \\ [])
View Sourcerename(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Rename a channel.
https://api.slack.com/methods/channels.rename
Examples
Slack.client(token)
|> Slack.Channel.rename(channel: "C1234567890", name: "newname")
setPurpose(client, body \\ [])
View SourcesetPurpose(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Set the purpose of a channel.
https://api.slack.com/methods/channels.setPurpose
Examples
Slack.client(token)
|> Slack.Channel.setPurpose(channel: "C1234567890", purpose: "Purpose")
setTopic(client, body \\ [])
View SourcesetTopic(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Set the topic of a channel.
https://api.slack.com/methods/channels.setTopic
Examples
Slack.client(token)
|> Slack.Channel.setTopic(channel: "C1234567890", topic: "Topic")
unarchive(client, body \\ [])
View Sourceunarchive(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Unarchive a channel.
https://api.slack.com/methods/channels.unarchive
Examples
Slack.client(token)
|> Slack.Channel.unarchive(channel: "C1234567890")