IBroker
in
Abstraction over the optional Talk backend
http://software-pattern.org/Broker
Tags
Table of Contents
Methods
- createConversation() : IConversation
- Create a new conversation
- deleteConversation() : void
- Delete a conversation by id
- hasBackend() : bool
- Check if the Talk backend is available
- newConversationOptions() : IConversationOptions
- Create a new instance of the objects object for specifics of a new conversation
Methods
createConversation()
Create a new conversation
public
createConversation(string $name, array<string|int, IUser> $moderators[, IConversationOptions|null $options = null ]) : IConversation
The conversation is private by default. Use the options parameter to make it public.
Parameters
- $name : string
- $moderators : array<string|int, IUser>
- $options : IConversationOptions|null = null
-
optional configuration for the conversation
Tags
Return values
IConversationdeleteConversation()
Delete a conversation by id
public
deleteConversation(string $id) : void
Parameters
- $id : string
-
conversation id
Tags
hasBackend()
Check if the Talk backend is available
public
hasBackend() : bool
Tags
Return values
boolnewConversationOptions()
Create a new instance of the objects object for specifics of a new conversation
public
newConversationOptions() : IConversationOptions