Slack

v0.0.12

Slack v0.0.12 Slack.Channel

A publicly listed communication channel in a team

Summary

Functions

archive(client, body \\ [])

Archive a channel

create(client, body \\ [])

Create a channel

history(client, query \\ [])

Retrieve channel history

info(client, query \\ [])

Get channel info

invite(client, body \\ [])

Invite a user to a channel

join(client, body \\ [])

Join a channel

kick(client, body \\ [])

Kick a user from a channel

leave(client, body \\ [])

Leave a channel

list(client, query \\ [])

List all of the channels in a team

mark(client, body \\ [])

Move the read cursor in a channel

rename(client, body \\ [])

Rename a channel

setPurpose(client, body \\ [])

Set the purpose of a channel

setTopic(client, body \\ [])

Set the topic of a channel

unarchive(client, body \\ [])

Unarchive a channel

Functions

archive(client, body \\ [])

Specs

archive(Slack.Client.t, Keyword.t) :: Slack.response

Archive a channel.

https://api.slack.com/methods/channels.archive

Examples

Slack.client(token)
|> Slack.Channel.archive(channel: "C1234567890")
create(client, body \\ [])

Specs

create(Slack.Client.t, Keyword.t) :: Slack.response

Create a channel.

https://api.slack.com/methods/channels.create

Examples

Slack.client(token)
|> Slack.Channel.create(name: "mychannel")
history(client, query \\ [])

Specs

history(Slack.Client.t, Keyword.t) :: Slack.response

Retrieve channel history.

https://api.slack.com/methods/channels.history

Examples

Slack.client(token)
|> Slack.Channel.history(channel: "C1234567890")
info(client, query \\ [])

Specs

info(Slack.Client.t, Keyword.t) :: Slack.response

Get channel info.

https://api.slack.com/methods/channels.info

Examples

Slack.client(token)
|> Slack.Channel.info(channel: "C1234567890")
invite(client, body \\ [])

Specs

invite(Slack.Client.t, Keyword.t) :: 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 \\ [])

Specs

join(Slack.Client.t, Keyword.t) :: Slack.response

Join a channel.

https://api.slack.com/methods/channels.join

Examples

Slack.client(token)
|> Slack.Channel.join(channel: "C1234567890")
kick(client, body \\ [])

Specs

kick(Slack.Client.t, Keyword.t) :: 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 \\ [])

Specs

leave(Slack.Client.t, Keyword.t) :: Slack.response

Leave a channel.

https://api.slack.com/methods/channels.leave

Examples

Slack.client(token)
|> Slack.Channel.leave(channel: "C1234567890")
list(client, query \\ [])

Specs

list(Slack.Client.t, Keyword.t) :: 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 \\ [])

Specs

mark(Slack.Client.t, Keyword.t) :: 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 \\ [])

Specs

rename(Slack.Client.t, Keyword.t) :: 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 \\ [])

Specs

setPurpose(Slack.Client.t, Keyword.t) :: 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 \\ [])

Specs

setTopic(Slack.Client.t, Keyword.t) :: 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 \\ [])

Specs

unarchive(Slack.Client.t, Keyword.t) :: Slack.response

Unarchive a channel.

https://api.slack.com/methods/channels.unarchive

Examples

Slack.client(token)
|> Slack.Channel.unarchive(channel: "C1234567890")