NotificationMessage
class NotificationMessage implements SerializableInterface
Traits
Methods
Call To Action URL - when the user clicks the notifcation - where should he go to ?
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Optional: Called before serialization (e.g. to remember/convert an unserializable prop)
Optional: Called after unserialize (e.g. load from db / recover or connect resource)
Optional: Override this method and specify the properties to include during serialize null = All Properties will be serialized (default) [] = No Properties will be serialized ['id'] = $this->id will be serialized
Call To Action URL - when the user clicks the notifcation - where should he go to ? Please provide a relative URL if you are linking to the current system!
No description
No description
No description
No description
We expect the ID of the instance not the STRING
Optional: If your module is providing multiple notifications of different type this will identify the correct registered type and its priority
No description
No description
No description
The Notification Token can be used to update this notification later or to revoke it Existing notifications with the same token from the same sourceInstanceId will automatically updated to reduce redundant messages for the user
No description
Details
at line 228
string
getCTAUrl()
Call To Action URL - when the user clicks the notifcation - where should he go to ?
at line 270
int|null
getDocumentIndexId()
No description
at line 154
string|null
getHtml()
No description
at line 210
string
getIconCSSClass()
No description
at line 37
int
getRecipientUserID()
No description
at line 108
int
getSourceInstanceId()
No description
at line 248
int
getSourceRegistryId()
No description
at line 54
string
getStatus()
No description
at line 127
string|null
getSubject()
No description
at line 182
string|null
getText()
No description
at line 88
string
getToken()
No description
at line 71
string
getType()
No description
in
SerializableObjectTrait at line 16
array
jsonSerialize()
No description
in
SerializableObjectTrait at line 219
void
onSerialize()
Optional: Called before serialization (e.g. to remember/convert an unserializable prop)
in
SerializableObjectTrait at line 225
void
onUnserialize()
Optional: Called after unserialize (e.g. load from db / recover or connect resource)
in
SerializableObjectTrait at line 24
SerializedObjectHelper
serializeObject()
No description
in
SerializableObjectTrait at line 212
protected array|null
serializePropertiesInclude()
Optional: Override this method and specify the properties to include during serialize null = All Properties will be serialized (default) [] = No Properties will be serialized ['id'] = $this->id will be serialized
at line 240
NotificationMessage
setCTAUrl(string $CTAUrl)
Call To Action URL - when the user clicks the notifcation - where should he go to ? Please provide a relative URL if you are linking to the current system!
at line 265
NotificationMessage
setDocumentIndexId(int|null $id)
No description
at line 164
NotificationMessage
setHtml(string $html)
No description
at line 174
NotificationMessage
setHtmlToken(I18nTokenHelper $textToken)
No description
at line 219
NotificationMessage
setIconCSSClass(string $iconCSSClass)
No description
at line 46
NotificationMessage
setRecipientUserID(int $recipientUserID)
No description
at line 119
NotificationMessage
setSourceInstanceId(int $sourceInstanceId)
We expect the ID of the instance not the STRING
at line 260
NotificationMessage
setSourceRegistryId(int $sourceRegistryId)
Optional: If your module is providing multiple notifications of different type this will identify the correct registered type and its priority
at line 63
NotificationMessage
setStatus(string $status = NotificationState::NEW)
No description
at line 136
NotificationMessage
setSubject(string $subject)
No description
at line 146
NotificationMessage
setSubjectToken(I18nTokenHelper $subject)
No description
at line 191
NotificationMessage
setText(string $text)
No description
at line 201
NotificationMessage
setTextToken(I18nTokenHelper $textToken)
No description
at line 100
NotificationMessage
setToken(string $token)
The Notification Token can be used to update this notification later or to revoke it Existing notifications with the same token from the same sourceInstanceId will automatically updated to reduce redundant messages for the user
at line 80
NotificationMessage
setType(string $type = NotificationType::ACTIVITY)
No description
in
SerializableObjectTrait at line 90
static object
unserializeObject(SerializedObjectHelper $SerializedObjectHelper)
No description
in
SerializableObjectTrait at line 121
static object
unserializeObjectFromJSON(string $json)
No description