PHP Класс Slack\RealTimeClient

Наследование: extends ApiClient, use trait Evenement\EventEmitterTrait
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$bots A map of bots.
$channels A map of channels.
$connected Indicates if the client is connected.
$dms A map of direct message channels.
$groups A map of groups.
$lastMessageId The ID of the last payload sent to Slack.
$pendingMessages An array of pending messages waiting for successful confirmation from Slack.
$team The team logged in to.
$users A map of users.
$websocket A websocket connection to the Slack API.

Открытые методы

Метод Описание
connect ( ) : React\Promise\PromiseInterface Connects to the real-time messaging server.
disconnect ( ) Disconnects the client.
getBotById ( string $id ) : React\Promise\PromiseInterface Gets a bot by its ID.
getBots ( ) : React\Promise\PromiseInterface Gets all bots in the Slack team.
getChannelById ( $id ) {@inheritDoc}
getChannels ( ) {@inheritDoc}
getDMById ( $id ) {@inheritDoc}
getDMs ( ) {@inheritDoc}
getGroupById ( $id ) {@inheritDoc}
getGroups ( ) {@inheritDoc}
getTeam ( ) {@inheritDoc}
getUserById ( $id ) {@inheritDoc}
getUsers ( ) {@inheritDoc}
isConnected ( ) : boolean Returns whether the client is connected.
postMessage ( Message $message ) {@inheritDoc}

Приватные методы

Метод Описание
onMessage ( Devristo\Phpws\Messaging\WebSocketMessageInterface $message ) Handles incoming websocket messages, parses them, and emits them as remote events.

Описание методов

connect() публичный Метод

Connects to the real-time messaging server.
public connect ( ) : React\Promise\PromiseInterface
Результат React\Promise\PromiseInterface

disconnect() публичный Метод

Disconnects the client.
public disconnect ( )

getBotById() публичный Метод

Gets a bot by its ID.
public getBotById ( string $id ) : React\Promise\PromiseInterface
$id string A bot ID.
Результат React\Promise\PromiseInterface A promise for a bot object.

getBots() публичный Метод

Gets all bots in the Slack team.
public getBots ( ) : React\Promise\PromiseInterface
Результат React\Promise\PromiseInterface A promise for an array of bots.

getChannelById() публичный Метод

{@inheritDoc}
public getChannelById ( $id )

getChannels() публичный Метод

{@inheritDoc}
public getChannels ( )

getDMById() публичный Метод

{@inheritDoc}
public getDMById ( $id )

getDMs() публичный Метод

{@inheritDoc}
public getDMs ( )

getGroupById() публичный Метод

{@inheritDoc}
public getGroupById ( $id )

getGroups() публичный Метод

{@inheritDoc}
public getGroups ( )

getTeam() публичный Метод

{@inheritDoc}
public getTeam ( )

getUserById() публичный Метод

{@inheritDoc}
public getUserById ( $id )

getUsers() публичный Метод

{@inheritDoc}
public getUsers ( )

isConnected() публичный Метод

Returns whether the client is connected.
public isConnected ( ) : boolean
Результат boolean

postMessage() публичный Метод

{@inheritDoc}
public postMessage ( Message $message )
$message Slack\Message\Message

Описание свойств

$bots защищенное свойство

A map of bots.
protected $bots

$channels защищенное свойство

A map of channels.
protected $channels

$connected защищенное свойство

Indicates if the client is connected.
protected $connected

$dms защищенное свойство

A map of direct message channels.
protected $dms

$groups защищенное свойство

A map of groups.
protected $groups

$lastMessageId защищенное свойство

The ID of the last payload sent to Slack.
protected $lastMessageId

$pendingMessages защищенное свойство

An array of pending messages waiting for successful confirmation from Slack.
protected $pendingMessages

$team защищенное свойство

The team logged in to.
protected $team

$users защищенное свойство

A map of users.
protected $users

$websocket защищенное свойство

A websocket connection to the Slack API.
protected $websocket