1. interface
  2. XELOS
  3. \
  4. Modules
  5. \
  6. SystemNotification
  7. \
  8. Hook
  9. \
  10. Base
  11. \
  12. NotificationChannelInterface

NotificationChannelInterface

interface NotificationChannelInterface

Interface NotificationChannelInterface

Methods

bool
flush()

Triggered after queuing, should reset your queue and do the actual sending

string|null
getDescription()

User visible description of this channel.

string
getName()

Returns the name of this channel.

UIAjaxComponent
getUserSettingsXUI(UserSetting $userSetting)

Return UI Component for the user to configure this channel and display the current status of this channel

void
markRead(Notification $notification)

Mark Notification as read in channel

int
queueNotification(Notification $notification)

No description

bool
send(Notification $notification)

No description

Details

at line 51
bool flush()

Triggered after queuing, should reset your queue and do the actual sending

Return Value

bool

at line 29
string|null getDescription()

User visible description of this channel.

Return Value

string|null

at line 22
string getName()

Returns the name of this channel.

Return Value

string

at line 38
UIAjaxComponent getUserSettingsXUI(UserSetting $userSetting)

Return UI Component for the user to configure this channel and display the current status of this channel

Parameters

UserSetting $userSetting

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

Return Value

UIAjaxComponent

at line 63
void markRead(Notification $notification)

Mark Notification as read in channel

Parameters

Notification $notification

Return Value

void

at line 45
int queueNotification(Notification $notification)

No description

Parameters

Notification $notification

Return Value

int

Number of items in Queue

at line 57
bool send(Notification $notification)

No description

Parameters

Notification $notification

Return Value

bool

True if sending was successfull