vB_Notification_VisitorMessage
extends vB_Notification
in package
Table of Contents
- FCM_SUPPORTED = rue
- TYPENAME = 'VisitorMessage'
- $triggers : mixed
- $updateEvents : mixed
- $validSourceChannelTypes : array<string|int, mixed>
- Channel types that will be allowed to send notifications.
- fetchPhraseArray() : mixed
- getFCMExtraData() : mixed
- handleUpdateEvents() : mixed
- Handle update events. The required data in $eventData depends on the particular event.
- addAdditionalRecipients() : mixed
- defineUnique() : mixed
- overwriteRule() : mixed
- typeEnabledForUser() : mixed
- validateAndCleanNotificationData() : mixed
- validateProvidedRecipients() : mixed
Constants
FCM_SUPPORTED
public
mixed
FCM_SUPPORTED
= rue
TYPENAME
public
mixed
TYPENAME
= 'VisitorMessage'
Properties
$triggers
protected
static mixed
$triggers
= array('new-visitormessage' => 20)
$updateEvents
protected
static mixed
$updateEvents
= array('read_vms', 'soft_deleted_node', 'physically_deleted_node', 'deleted_user')
$validSourceChannelTypes
Channel types that will be allowed to send notifications.
protected
array<string|int, mixed>
$validSourceChannelTypes
= array('vm' => 1)
Keep this in sync with vB_Channel::$channelTypes
Methods
fetchPhraseArray()
public
static fetchPhraseArray(mixed $notificationData) : mixed
Parameters
- $notificationData : mixed
Tags
Return values
mixed —getFCMExtraData()
public
static getFCMExtraData(mixed $data, mixed $languageids) : mixed
Parameters
- $data : mixed
- $languageids : mixed
Return values
mixed —handleUpdateEvents()
Handle update events. The required data in $eventData depends on the particular event.
public
static handleUpdateEvents(string $event, array<string|int, mixed> $eventData) : mixed
Children may also handle their specific events.
Parameters
- $event : string
-
One of the event strings in static::$updateEvents
- $eventData : array<string|int, mixed>
-
When $event is 'read_topic'|'read_channel', expects: int 'nodeid' int 'userid' (Optional)
Return values
mixed —addAdditionalRecipients()
protected
addAdditionalRecipients() : mixed
Return values
mixed —defineUnique()
protected
final static defineUnique(mixed $notificationData, mixed $skipValidation) : mixed
Parameters
- $notificationData : mixed
- $skipValidation : mixed
Return values
mixed —overwriteRule()
protected
overwriteRule() : mixed
Return values
mixed —typeEnabledForUser()
protected
typeEnabledForUser(mixed $user) : mixed
Parameters
- $user : mixed
Return values
mixed —validateAndCleanNotificationData()
protected
validateAndCleanNotificationData(mixed $notificationData) : mixed
Parameters
- $notificationData : mixed
Return values
mixed —validateProvidedRecipients()
protected
validateProvidedRecipients(mixed $recipients) : mixed
Parameters
- $recipients : mixed