class PushNotificationChannel extends NotificationChannel

Class PushNotificationHook

Constants

CHANNELS

SENDING_DELAY

Properties

SystemPwaController $mod
array $_hook_info

Hook Information "id" => "4914" "instance_id" => "api_microsoft" "name" => "oauth_client" "hook" => "webservice.oauth_client" "type" => "object" "registry_name" => "oauth_client" "function_name" => "" "internal" => "no" "dep_mode" => "local" "active" => "yes" "title" => "Basic functions" "description" => "" "options" => ""

from  BaseHook

Methods

bool
flush()

No description

string|null
getDescription()

No description

string
getHookDescription()

No description

from  BaseHook
string
getHookIdentifier()

Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name

from  BaseHook
array
getHookInfoValue(bool $key = false)

Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)

from  BaseHook
string
getHookInstance()

No description

from  BaseHook
string
getHookName()

No description

from  BaseHook
string
getHookTitle()

No description

from  BaseHook
string
getName()

Channel Name

getObject()

No description

from  BaseHook
mixed
getOption(string $key)

Returns the option with $key set in the config.yml

from  BaseHook
getUserSettingsXUI(UserSetting $userSetting)

Settings for user

init()

Initialize

bool
isAvailable()

No description

void
markRead(Notification $notification)

Mark notification read in channel

int
queueNotification(Notification $notification)

Add notification for processing

bool
send(Notification $notification)

No description

Details

bool flush()

No description

Return Value

bool

at line 33
string|null getDescription()

No description

Return Value

string|null

in BaseHook at line 76
string getHookDescription()

No description

Return Value

string

in BaseHook at line 55
string getHookIdentifier()

Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name

Return Value

string

in BaseHook at line 45
array getHookInfoValue(bool $key = false)

Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)

Parameters

bool $key

Return Value

array

in BaseHook at line 69
string getHookInstance()

No description

Return Value

string

in BaseHook at line 62
string getHookName()

No description

Return Value

string

in BaseHook at line 83
string getHookTitle()

No description

Return Value

string

at line 29
string getName()

Channel Name

Return Value

string

in BaseHook at line 88
getObject()

No description

in BaseHook at line 97
mixed getOption(string $key)

Returns the option with $key set in the config.yml

Parameters

string $key

Return Value

mixed

protected UIAjaxComponent getStandardSettingsXUI(UserSetting $userSetting)

No description

Parameters

UserSetting $userSetting

Return Value

UIAjaxComponent

at line 76
UIAjaxComponent getUserSettingsXUI(UserSetting $userSetting)

Settings for user

Parameters

UserSetting $userSetting

You are given the current Settings of this user for this channel

Return Value

UIAjaxComponent

Exceptions

ErrorException

init()

Initialize

at line 40
bool isAvailable()

No description

Return Value

bool

at line 62
void markRead(Notification $notification)

Mark notification read in channel

Parameters

Notification $notification

Return Value

void

Exceptions

ErrorException

int queueNotification(Notification $notification)

Add notification for processing

Parameters

Notification $notification

Return Value

int

Number of items in Queue

at line 47
bool send(Notification $notification)

No description

Parameters

Notification $notification

Return Value

bool

True if sending was successfull