Table of Contents
Methods
-
addReaction()
: void
-
channelIdFromThreadId()
: string
-
createResponse()
: ResponseInterface|null
-
decodeThreadId()
: mixed
-
deleteMessage()
: void
-
disconnect()
: void
-
editMessage()
: SentMessage
-
encodeThreadId()
: string
-
fetchChannelInfo()
: ChannelInfo|null
-
fetchMessages()
: FetchResult
-
fetchThread()
: ThreadInfo
-
getBotUserId()
: string|null
-
getFormatConverter()
: FormatConverter|null
-
getName()
: string
-
getUser()
: UserInfo|null
-
initialize()
: void
-
openDM()
: string|null
-
parseWebhook()
: Message
-
postMessage()
: SentMessage
-
removeReaction()
: void
-
startTyping()
: void
-
stream()
: SentMessage|null
-
verifyWebhook()
: ResponseInterface|null
addReaction()
public
addReaction(string $threadId, string $messageId, string $emoji) : void
Parameters
-
$threadId
: string
-
-
$messageId
: string
-
-
$emoji
: string
-
channelIdFromThreadId()
public
channelIdFromThreadId(string $threadId) : string
Parameters
-
$threadId
: string
-
createResponse()
public
createResponse() : ResponseInterface|null
Return values
ResponseInterface|null
decodeThreadId()
public
decodeThreadId(string $threadId) : mixed
Parameters
-
$threadId
: string
-
deleteMessage()
public
deleteMessage(string $threadId, string $messageId) : void
Parameters
-
$threadId
: string
-
-
$messageId
: string
-
disconnect()
public
disconnect() : void
editMessage()
public
editMessage(string $threadId, string $messageId, PostableMessage $message) : SentMessage
Parameters
-
$threadId
: string
-
-
$messageId
: string
-
-
$message
: PostableMessage
-
encodeThreadId()
public
encodeThreadId(mixed $platformData) : string
Parameters
-
$platformData
: mixed
-
fetchChannelInfo()
public
fetchChannelInfo(string $channelId) : ChannelInfo|null
Parameters
-
$channelId
: string
-
fetchMessages()
public
fetchMessages(string $threadId[, FetchOptions|null $options = null ]) : FetchResult
Parameters
-
$threadId
: string
-
-
$options
: FetchOptions|null
= null
-
fetchThread()
public
fetchThread(string $threadId) : ThreadInfo
Parameters
-
$threadId
: string
-
getBotUserId()
public
getBotUserId() : string|null
Return values
string|null
public
getFormatConverter() : FormatConverter|null
getName()
public
getName() : string
getUser()
public
getUser(string $userId) : UserInfo|null
Parameters
-
$userId
: string
-
initialize()
public
initialize(Chat $chat) : void
Parameters
-
$chat
: Chat
-
openDM()
public
openDM(string $userId) : string|null
Parameters
-
$userId
: string
-
Return values
string|null
parseWebhook()
public
parseWebhook(ServerRequestInterface $request) : Message
Parameters
-
$request
: ServerRequestInterface
-
postMessage()
public
postMessage(string $threadId, PostableMessage $message) : SentMessage
Parameters
-
$threadId
: string
-
-
$message
: PostableMessage
-
removeReaction()
public
removeReaction(string $threadId, string $messageId, string $emoji) : void
Parameters
-
$threadId
: string
-
-
$messageId
: string
-
-
$emoji
: string
-
startTyping()
public
startTyping(string $threadId) : void
Parameters
-
$threadId
: string
-
stream()
public
stream(string $threadId, iterable<string|int, mixed> $textStream[, array<string|int, mixed> $options = [] ]) : SentMessage|null
Parameters
-
$threadId
: string
-
-
$textStream
: iterable<string|int, mixed>
-
-
$options
: array<string|int, mixed>
= []
-
verifyWebhook()
public
verifyWebhook(ServerRequestInterface $request) : ResponseInterface|null
Parameters
-
$request
: ServerRequestInterface
-
Return values
ResponseInterface|null