Overview
  • Namespace
  • Class

Namespaces

  • Slack
    • Message

Classes

  • ApiClient
  • Bot
  • Channel
  • ClientObject
  • DataObject
  • DirectMessageChannel
  • Group
  • Payload
  • RealTimeClient
  • Team
  • User

Interfaces

  • ChannelInterface
  • Exception

Exceptions

  • ApiException
  • ConnectionException
  • UserNotFoundException

Class Group

Contains information about a private group channel.

Slack\DataObject implements JsonSerializable
Extended by Slack\ClientObject
Extended by Slack\Channel implements Slack\ChannelInterface
Extended by Slack\Group
Namespace: Slack
Located at Group.php

Methods summary

public React\Promise\PromiseInterface
# rename( string $name )

Renames the group.

Renames the group.

Parameters

$name
The name to set to.

Returns

React\Promise\PromiseInterface

Overrides

Slack\Channel::rename
public React\Promise\PromiseInterface
# setPurpose( string $text )

Sets the group's purpose text.

Sets the group's purpose text.

Parameters

$text
The new purpose text to set to.

Returns

React\Promise\PromiseInterface

Overrides

Slack\Channel::setPurpose
public React\Promise\PromiseInterface
# setTopic( string $text )

Sets the group topic text.

Sets the group topic text.

Parameters

$text
The new topic text to set to.

Returns

React\Promise\PromiseInterface

Overrides

Slack\Channel::setTopic
public React\Promise\PromiseInterface
# archive( )

Archives the group.

Archives the group.

Returns

React\Promise\PromiseInterface

Overrides

Slack\Channel::archive
public React\Promise\PromiseInterface
# unarchive( )

Un-archives the group.

Un-archives the group.

Returns

React\Promise\PromiseInterface

Overrides

Slack\Channel::unarchive
public React\Promise\PromiseInterface
# inviteUser( Slack\User $user )

Invites a user to the group.

Invites a user to the group.

Parameters

$user
The user to invite.

Returns

React\Promise\PromiseInterface

Overrides

Slack\Channel::inviteUser
public React\Promise\PromiseInterface
# kickUser( Slack\User $user )

Kicks a user from the group.

Kicks a user from the group.

Parameters

$user
The user to kick.

Returns

React\Promise\PromiseInterface

Overrides

Slack\Channel::kickUser
public React\Promise\PromiseInterface
# open( )

Opens the group.

Opens the group.

Returns

React\Promise\PromiseInterface
public
# close( )

Overrides

Slack\Channel::close

Methods inherited from Slack\Channel

getCreator(), getId(), getMembers(), getName(), getPurpose(), getTimeCreated(), getTopic(), getUnreadCount(), isArchived()

Methods inherited from Slack\ClientObject

__construct(), getClient()

Methods inherited from Slack\DataObject

fromData(), jsonSerialize(), jsonUnserialize()

Properties summary

Properties inherited from Slack\ClientObject

$client

Properties inherited from Slack\DataObject

$data

API documentation generated by ApiGen