abstract class NotificationChannel extends BaseHook implements NotificationChannelInterface

Class NotificationChannel

Constants

CHANNELS

SENDING_DELAY

Properties

Controller $mod

Instance providing the hook

from  BaseHook
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()

No description

getObject()

No description

from  BaseHook
mixed
getOption(string $key)

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

from  BaseHook
getStandardSettingsXUI(UserSetting $userSetting)

No description

init()

Initialize

bool
isAvailable()

Returns true if this hook is available otherwise false.

from  BaseHook
int
queueNotification(Notification $notification)

Add notification for processing

Details

at line 83
bool flush()

No description

Return Value

bool

at line 111
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 104
string getName()

No description

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

at line 41
protected UIAjaxComponent getStandardSettingsXUI(UserSetting $userSetting)

No description

Parameters

UserSetting $userSetting

Return Value

UIAjaxComponent

at line 31
init()

Initialize

in BaseHook at line 117
abstract bool isAvailable()

Returns true if this hook is available otherwise false.

Return Value

bool

at line 76
int queueNotification(Notification $notification)

Add notification for processing

Parameters

Notification $notification

Return Value

int

Number of items in Queue