Slack v0.2.1 Slack.Group View Source
Functions for working with private channels (groups)
Link to this section Summary
Functions
Archive a private channel.
Close a private channel.
Create a private channel.
Replace a private channel.
Get the history of a private channel.
Get the info of a private channel.
Invite a user to a private channel.
Kick a user from a private channel.
Leave a private channel.
List private channels.
Move the read cursor in a private channel.
Open a private channel.
Rename a private channel.
Set the purpose of a private channel.
Set the topic of a private channel.
Unarchive a private channel.
Link to this section Functions
archive(client, body \\ [])
View Sourcearchive(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Archive a private channel.
https://api.slack.com/methods/groups.archive
Examples
Slack.Group.archive(client, channel: "G1234567890")
close(client, body \\ [])
View Sourceclose(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Close a private channel.
https://api.slack.com/methods/groups.close
Examples
Slack.Group.close(client, channel: "G1234567890")
create(client, body \\ [])
View Sourcecreate(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Create a private channel.
https://api.slack.com/methods/groups.create
Examples
Slack.Group.create(client, name: "newchannel")
createChild(client, body \\ [])
View SourcecreateChild(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Replace a private channel.
https://api.slack.com/methods/groups.createChild
Examples
Slack.Group.createChild(client, channel: "G1234567890")
history(client, query \\ [])
View Sourcehistory(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Get the history of a private channel.
https://api.slack.com/methods/groups.history
Examples
Slack.Group.history(client, channel: "G1234567890")
info(client, query \\ [])
View Sourceinfo(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Get the info of a private channel.
https://api.slack.com/methods/groups.info
Examples
Slack.Group.info(client, channel: "G1234567890")
invite(client, body \\ [])
View Sourceinvite(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Invite a user to a private channel.
https://api.slack.com/methods/groups.invite
Examples
Slack.Group.invite(client, channel: "G1234567890", user: "U1234567890")
kick(client, body \\ [])
View Sourcekick(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Kick a user from a private channel.
https://api.slack.com/methods/groups.kick
Examples
Slack.Group.kick(client, channel: "G1234567890", user: "U1234567890")
leave(client, body \\ [])
View Sourceleave(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Leave a private channel.
https://api.slack.com/methods/groups.leave
Examples
Slack.Group.leave(client, channel: "G1234567890")
list(client, query \\ [])
View Sourcelist(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
List private channels.
https://api.slack.com/methods/groups.list
Examples
Slack.Group.list(client)
mark(client, body \\ [])
View Sourcemark(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Move the read cursor in a private channel.
https://api.slack.com/methods/groups.mark
Examples
Slack.Group.mark(client, channel: "G1234567890", ts: 1234567890.123456)
open(client, body \\ [])
View Sourceopen(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Open a private channel.
https://api.slack.com/methods/groups.open
Examples
Slack.Group.open(client, channel: "G1234567890")
rename(client, body \\ [])
View Sourcerename(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Rename a private channel.
https://api.slack.com/methods/groups.rename
Examples
Slack.Group.rename(client, channel: "G1234567890", name: "newname")
setPurpose(client, body \\ [])
View SourcesetPurpose(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Set the purpose of a private channel.
https://api.slack.com/methods/groups.setPurpose
Examples
Slack.Group.setPurpose(client, channel: "G1234567890", purpose: "purpose")
setTopic(client, body \\ [])
View SourcesetTopic(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Set the topic of a private channel.
https://api.slack.com/methods/groups.setTopic
Examples
Slack.Group.setTopic(client, channel: "G1234567890", topic: "topic")
unarchive(client, body \\ [])
View Sourceunarchive(Slack.Client.t(), Keyword.t()) :: Slack.slack_response()
Unarchive a private channel.
https://api.slack.com/methods/groups.unarchive
Examples
Slack.Group.unarchive(client, channel: "G1234567890")