vB_Library_FCMessaging
extends vB_Library
in package
vB_Library_FCMessaging
Tags
Table of Contents
Constants
- CLICK_ACTION_COMMENT = "SHOW_COMMENT_ACTION"
- CLICK_ACTION_POST = "SHOW_POST_ACTION"
- CLICK_ACTION_PRIVATEMESSAGE = "SHOW_PM_ACTION"
- CLICK_ACTION_THREAD = "SHOW_THREAD_ACTION"
- CLICK_ACTION_VISITORMESSAGE = "SHOW_VISITOR_MESSAGES_ACTION"
- ERROR_TYPE_GENERIC = "GENERIC"
- ERROR_TYPE_SETTING = "SETTING"
- MESSAGE_TYPE_NOTIFICATION = "notification"
- MESSAGE_TYPE_PRIVATEMESSAGE = "privatemessage"
Methods
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- clearCache() : mixed
- convertUseridsToDeviceTokens() : mixed
- enabled() : mixed
- getContentInstance() : mixed
- handleOffloadedTask() : mixed
- instance() : static
- Returns singleton instance of self.
- logError() : mixed
- monitorWords() : mixed
- Checks if the text contains monitored words, and if so, sends notifications to admins and moderators if the setting is on.
- queueMessage() : mixed
- removeDeviceToken() : mixed
- sendMessageFromCron() : mixed
- sendMessages() : mixed
- testSendMessage() : mixed
- testServerKey() : mixed
- updateDeviceToken() : mixed
Constants
CLICK_ACTION_COMMENT
public
mixed
CLICK_ACTION_COMMENT
= "SHOW_COMMENT_ACTION"
CLICK_ACTION_POST
public
mixed
CLICK_ACTION_POST
= "SHOW_POST_ACTION"
CLICK_ACTION_PRIVATEMESSAGE
public
mixed
CLICK_ACTION_PRIVATEMESSAGE
= "SHOW_PM_ACTION"
CLICK_ACTION_THREAD
public
mixed
CLICK_ACTION_THREAD
= "SHOW_THREAD_ACTION"
CLICK_ACTION_VISITORMESSAGE
public
mixed
CLICK_ACTION_VISITORMESSAGE
= "SHOW_VISITOR_MESSAGES_ACTION"
ERROR_TYPE_GENERIC
public
mixed
ERROR_TYPE_GENERIC
= "GENERIC"
ERROR_TYPE_SETTING
public
mixed
ERROR_TYPE_SETTING
= "SETTING"
MESSAGE_TYPE_NOTIFICATION
public
mixed
MESSAGE_TYPE_NOTIFICATION
= "notification"
MESSAGE_TYPE_PRIVATEMESSAGE
public
mixed
MESSAGE_TYPE_PRIVATEMESSAGE
= "privatemessage"
Methods
__serialize()
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed>__sleep()
public
__sleep() : array<string|int, mixed>
Return values
array<string|int, mixed>__unserialize()
public
__unserialize(array<string|int, mixed> $serialized) : void
Parameters
- $serialized : array<string|int, mixed>
__wakeup()
public
__wakeup() : void
clearCache()
public
static clearCache() : mixed
convertUseridsToDeviceTokens()
public
convertUseridsToDeviceTokens(mixed $recipientUserids) : mixed
Parameters
- $recipientUserids : mixed
enabled()
public
enabled() : mixed
getContentInstance()
public
static getContentInstance(mixed $contenttypeid) : mixed
Parameters
- $contenttypeid : mixed
handleOffloadedTask()
public
handleOffloadedTask(mixed $messageHashes) : mixed
Parameters
- $messageHashes : mixed
instance()
Returns singleton instance of self.
public
static instance(mixed $class) : static
Parameters
- $class : mixed
Return values
static —- Reference to singleton instance of the requested library class
logError()
public
logError(mixed $message, mixed $data[, mixed $errorType = self::ERROR_TYPE_GENERIC ]) : mixed
Parameters
- $message : mixed
- $data : mixed
- $errorType : mixed = self::ERROR_TYPE_GENERIC
monitorWords()
Checks if the text contains monitored words, and if so, sends notifications to admins and moderators if the setting is on.
public
monitorWords(mixed $text, mixed $type, mixed $nodeid[, mixed $userid = null ][, mixed $insertNotifications = true ][, mixed $currentuserid = 0 ]) : mixed
Parameters
- $text : mixed
- $type : mixed
- $nodeid : mixed
- $userid : mixed = null
- $insertNotifications : mixed = true
- $currentuserid : mixed = 0
Tags
queueMessage()
public
queueMessage(mixed $recipientIds, mixed $messageType[, mixed $extra = array() ]) : mixed
Parameters
- $recipientIds : mixed
- $messageType : mixed
- $extra : mixed = array()
removeDeviceToken()
public
removeDeviceToken() : mixed
sendMessageFromCron()
public
sendMessageFromCron(mixed $messageid[, mixed $clientIds = array() ]) : mixed
Parameters
- $messageid : mixed
- $clientIds : mixed = array()
sendMessages()
public
sendMessages(mixed $messageHashes) : mixed
Parameters
- $messageHashes : mixed
testSendMessage()
public
testSendMessage(mixed $registration_ids) : mixed
Parameters
- $registration_ids : mixed
testServerKey()
public
testServerKey() : mixed
updateDeviceToken()
public
updateDeviceToken(mixed $deviceToken) : mixed
Parameters
- $deviceToken : mixed