vBulletin 5.6.5 API

vB_Library_FCMessaging extends vB_Library
in package

vB_Library_FCMessaging

Tags
access

public

Table of Contents

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"
$assertor  : mixed
$failureReason  : mixed
$fcm_url  : mixed
$instance  : mixed
$serverKey  : mixed
$worker  : mixed
__serialize()  : mixed
__sleep()  : mixed
__unserialize()  : mixed
__wakeup()  : mixed
clearCache()  : mixed
convertUseridsToDeviceTokens()  : mixed
enabled()  : mixed
getContentInstance()  : mixed
handleOffloadedTask()  : mixed
instance()  : vB_PageCache
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
__construct()  : mixed
Constructor
getLibraryClassNameInternal()  : mixed
getMessageId()  : mixed
getNextRetryInterval()  : mixed
handleNormalResponse()  : mixed
offloadTasks()  : mixed
postToFCMServer()  : mixed
prepareTitleAndBodyForFCM()  : mixed
processRequestResponse()  : mixed
registerRetry()  : mixed
unregisterRetry()  : 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"

Properties

$fcm_url

protected mixed $fcm_url = 'https://fcm.googleapis.com/fcm/send'

$instance

protected static mixed $instance = array()

Methods

__serialize()

public __serialize() : mixed
Return values
mixed —

__sleep()

public __sleep() : mixed
Return values
mixed —

__unserialize()

public __unserialize(mixed $serialized) : mixed
Parameters
$serialized : mixed
Return values
mixed —

__wakeup()

public __wakeup() : mixed
Return values
mixed —

clearCache()

public static clearCache() : mixed
Return values
mixed —

convertUseridsToDeviceTokens()

public convertUseridsToDeviceTokens(mixed $recipientUserids) : mixed
Parameters
$recipientUserids : mixed
Return values
mixed —

enabled()

public enabled() : mixed
Return values
mixed —

getContentInstance()

public static getContentInstance(mixed $contenttypeid) : mixed
Parameters
$contenttypeid : mixed
Return values
mixed —

handleOffloadedTask()

public handleOffloadedTask(mixed $messageHashes) : mixed
Parameters
$messageHashes : mixed
Return values
mixed —

instance()

Returns singleton instance of self.

public static instance(mixed $class) : vB_PageCache
Parameters
$class : mixed
Return values
vB_PageCache —
  • Reference to singleton instance of the cache handler

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
Return values
mixed —

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) : mixed
Parameters
$text : mixed
$type : mixed
$nodeid : mixed
$userid : mixed = null
$insertNotifications : mixed = true
$currentuserid : mixed
Return values
mixed —

queueMessage()

public queueMessage(mixed $recipientIds, mixed $messageType[, mixed $extra = array() ]) : mixed
Parameters
$recipientIds : mixed
$messageType : mixed
$extra : mixed = array()
Return values
mixed —

removeDeviceToken()

public removeDeviceToken() : mixed
Return values
mixed —

sendMessageFromCron()

public sendMessageFromCron(mixed $messageid[, mixed $clientIds = array() ]) : mixed
Parameters
$messageid : mixed
$clientIds : mixed = array()
Return values
mixed —

sendMessages()

public sendMessages(mixed $messageHashes) : mixed
Parameters
$messageHashes : mixed
Return values
mixed —

testSendMessage()

public testSendMessage(mixed $registration_ids) : mixed
Parameters
$registration_ids : mixed
Return values
mixed —

testServerKey()

public testServerKey() : mixed
Return values
mixed —

updateDeviceToken()

public updateDeviceToken(mixed $deviceToken) : mixed
Parameters
$deviceToken : mixed
Return values
mixed —

__construct()

Constructor

protected __construct() : mixed
Return values
mixed —

getLibraryClassNameInternal()

protected static getLibraryClassNameInternal(mixed $controller) : mixed
Parameters
$controller : mixed
Return values
mixed —

getMessageId()

private getMessageId(mixed $postData[, mixed $readOnly = false ]) : mixed
Parameters
$postData : mixed
$readOnly : mixed = false
Return values
mixed —

getNextRetryInterval()

private getNextRetryInterval(mixed $nth_attempt[, mixed $retry_after_delta_seconds = null ]) : mixed
Parameters
$nth_attempt : mixed
$retry_after_delta_seconds : mixed = null
Return values
mixed —

handleNormalResponse()

private handleNormalResponse(mixed $registration_ids, mixed $postData, mixed $response, mixed $body) : mixed
Parameters
$registration_ids : mixed
$postData : mixed
$response : mixed
$body : mixed
Return values
mixed —

offloadTasks()

private offloadTasks(mixed $hashes) : mixed
Parameters
$hashes : mixed
Return values
mixed —

postToFCMServer()

private postToFCMServer(mixed $postData[, mixed $skipResultProcessing = false ]) : mixed
Parameters
$postData : mixed
$skipResultProcessing : mixed = false
Return values
mixed —

prepareTitleAndBodyForFCM()

private prepareTitleAndBodyForFCM(mixed $title, mixed $body) : mixed
Parameters
$title : mixed
$body : mixed
Return values
mixed —

processRequestResponse()

private processRequestResponse(mixed $response, mixed $postData) : mixed
Parameters
$response : mixed
$postData : mixed
Return values
mixed —

registerRetry()

private registerRetry(mixed $registration_ids, mixed $postData[, mixed $response = array() ]) : mixed
Parameters
$registration_ids : mixed
$postData : mixed
$response : mixed = array()
Return values
mixed —

unregisterRetry()

private unregisterRetry(mixed $registration_ids, mixed $postData) : mixed
Parameters
$registration_ids : mixed
$postData : mixed
Return values
mixed —

Search results