ITalkBackend
in
Interface for the Talk app to implement
Other apps must not implement nor use this interface in any way. Use the broker instead
Tags
Table of Contents
Methods
- createConversation() : IConversation
- deleteConversation() : void
- Delete a conversation by id
- isAllowedToCreateConversations() : bool
- Check if the logged-in user is allowed to create conversations
- isEnabledForUser() : bool
- Check if the Talk backend is enabled for the logged-in user
Methods
createConversation()
public
createConversation(string $name, array<string|int, IUser> $moderators, IConversationOptions $options) : IConversation
Parameters
- $name : string
- $moderators : array<string|int, IUser>
- $options : IConversationOptions
-
configuration for the conversation
Tags
Return values
IConversationdeleteConversation()
Delete a conversation by id
public
deleteConversation(string $id) : void
Parameters
- $id : string
-
conversation id
Tags
isAllowedToCreateConversations()
Check if the logged-in user is allowed to create conversations
public
isAllowedToCreateConversations() : bool
Also returns false when no backend is enabled for the user
Tags
Return values
boolisEnabledForUser()
Check if the Talk backend is enabled for the logged-in user
public
isEnabledForUser() : bool