GroupsFacet

Kind: global class

• GroupsFacet
  • .archive(channel, [optCb])
  • .close(channel, [optCb])
  • .create(name, [optCb])
  • .createChild(channel, [optCb])
  • .history(channel, [opts], [optCb])
  • .info(channel, [optCb])
  • .invite(channel, user, [optCb])
  • .kick(channel, user, [optCb])
  • .leave(channel, [optCb])
  • .list([opts], [optCb])
  • .mark(channel, ts, [optCb])
  • .open(channel, [optCb])
  • .rename(channel, name, [optCb])
  • .replies(channel, thread_ts, [optCb])
  • .setPurpose(channel, purpose, [optCb])
  • .setTopic(channel, topic, [optCb])
  • .unarchive(channel, [optCb])

groupsFacet.archive(channel, [optCb])

Archives a private channel.

Kind: instance method of [GroupsFacet](#GroupsFacet)
See: groups.archive

Param	Type	Description
channel	?	Private channel to archive
[optCb]	function	Optional callback, if not using promises.

groupsFacet.close(channel, [optCb])

Closes a private channel.

Kind: instance method of [GroupsFacet](#GroupsFacet)
See: groups.close

Param	Type	Description
channel	?	Private channel to close.
[optCb]	function	Optional callback, if not using promises.

groupsFacet.create(name, [optCb])

Creates a private channel.

Kind: instance method of [GroupsFacet](#GroupsFacet)
See: groups.create

Param	Type	Description
name	?	Name of private channel to create
[optCb]	function	Optional callback, if not using promises.

groupsFacet.createChild(channel, [optCb])

Clones and archives a private channel.

Kind: instance method of [GroupsFacet](#GroupsFacet)
See: groups.createChild

Param	Type	Description
channel	?	Private channel to clone and archive.
[optCb]	function	Optional callback, if not using promises.

groupsFacet.history(channel, [opts], [optCb])

Fetches history of messages and events from a private channel.

Kind: instance method of [GroupsFacet](#GroupsFacet)
See: groups.history

Param	Type	Description
channel	?	Private channel to fetch history for.
[opts]	Object
opts.latest	?	End of time range of messages to include in results.
opts.oldest	?	Start of time range of messages to include in results.
opts.inclusive	?	Include messages with latest or oldest timestamp in results.
opts.count	?	Number of messages to return, between 1 and 1000.
opts.unreads	?	Include unread_count_display in the output?
[optCb]	function	Optional callback, if not using promises.

groupsFacet.info(channel, [optCb])

Gets information about a private channel.

Kind: instance method of [GroupsFacet](#GroupsFacet)
See: groups.info

Param	Type	Description
channel	?	Private channel to get info on
[optCb]	function	Optional callback, if not using promises.

groupsFacet.invite(channel, user, [optCb])

Invites a user to a private channel.

Kind: instance method of [GroupsFacet](#GroupsFacet)
See: groups.invite

Param	Type	Description
channel	?	Private channel to invite user to.
user	?	User to invite.
[optCb]	function	Optional callback, if not using promises.

groupsFacet.kick(channel, user, [optCb])

Removes a user from a private channel.

Kind: instance method of [GroupsFacet](#GroupsFacet)
See: groups.kick

Param	Type	Description
channel	?	Private channel to remove user from.
user	?	User to remove from private channel.
[optCb]	function	Optional callback, if not using promises.

groupsFacet.leave(channel, [optCb])

Leaves a private channel.

Kind: instance method of [GroupsFacet](#GroupsFacet)
See: groups.leave

Param	Type	Description
channel	?	Private channel to leave
[optCb]	function	Optional callback, if not using promises.

groupsFacet.list([opts], [optCb])

Lists private channels that the calling user has access to.

Kind: instance method of [GroupsFacet](#GroupsFacet)
See: groups.list

Param	Type	Description
[opts]	Object
opts.exclude_archived	?	Don’t return archived private channels.
[optCb]	function	Optional callback, if not using promises.

groupsFacet.mark(channel, ts, [optCb])

Sets the read cursor in a private channel.

Kind: instance method of [GroupsFacet](#GroupsFacet)
See: groups.mark

Param	Type	Description
channel	?	Private channel to set reading cursor in.
ts	?	Timestamp of the most recently seen message.
[optCb]	function	Optional callback, if not using promises.

groupsFacet.open(channel, [optCb])

Opens a private channel.

Kind: instance method of [GroupsFacet](#GroupsFacet)
See: groups.open

Param	Type	Description
channel	?	Private channel to open.
[optCb]	function	Optional callback, if not using promises.

groupsFacet.rename(channel, name, [optCb])

Renames a private channel.

Kind: instance method of [GroupsFacet](#GroupsFacet)
See: groups.rename

Param	Type	Description
channel	?	Private channel to rename
name	?	New name for private channel.
[optCb]	function	Optional callback, if not using promises.

groupsFacet.replies(channel, thread_ts, [optCb])

Retrieve a thread of messages posted to a private channel.

Kind: instance method of [GroupsFacet](#GroupsFacet)
See: groups.replies

Param	Type	Description
channel	?	Private channel to fetch thread from
thread_ts	?	Unique identifier of a thread’s parent message
[optCb]	function	Optional callback, if not using promises.

groupsFacet.setPurpose(channel, purpose, [optCb])

Sets the purpose for a private channel.

Kind: instance method of [GroupsFacet](#GroupsFacet)
See: groups.setPurpose

Param	Type	Description
channel	?	Private channel to set the purpose of
purpose	?	The new purpose
[optCb]	function	Optional callback, if not using promises.

groupsFacet.setTopic(channel, topic, [optCb])

Sets the topic for a private channel.

Kind: instance method of [GroupsFacet](#GroupsFacet)
See: groups.setTopic

Param	Type	Description
channel	?	Private channel to set the topic of
topic	?	The new topic
[optCb]	function	Optional callback, if not using promises.

groupsFacet.unarchive(channel, [optCb])

Unarchives a private channel.

Kind: instance method of [GroupsFacet](#GroupsFacet)
See: groups.unarchive

Param	Type	Description
channel	?	Private channel to unarchive
[optCb]	function	Optional callback, if not using promises.