Standards  1.0
Public Member Functions | Static Public Member Functions | Data Fields
iNotificationSystem_Notification Interface Reference
Notification System

A notification entity for the NotificationSystem standard. More...

Public Member Functions

 setTitle ($title)
 
 getTitle ()
 
 setBody ($content)
 
 getBody ()
 
 setLabel ($label)
 
 getLabel ()
 
 dismiss ($unDismiss=false)
 
 isDismissed ()
 
 hide ()
 
 show ()
 
 isViewed ()
 
 setUser ($userId)
 
 email ()
 
 getUser ()
 

Static Public Member Functions

static getRawView ($injections, $level=1)
 

Data Fields

const iType = "Notification"
 
const iShort = "n"
 
const iParent = "iNotificationSystem"
 

Detailed Description

A notification entity for the NotificationSystem standard.

Linker:

  • "Notification"(id): This should be a page where a user can view their notifications and should focus in on the notification with the id = to the get variable "id".

Tokens:

  • "<": Sorts from higest to lowest or newest to oldest.
    • Allowed values:
      • string time
  • ">": Sorts from lowest to higest or oldest to newest.
    • Allowed values:
      • string time
  • ";": Not true checker.
    • Allowed values:
      • string viewed
      • string dismissed
  • "~": Is true checker.
    • Allowed values:
      • string viewed
      • string dismissed
  • "#": Search for an id.
    • Allowed values:
      • int Any int id(1, 6236, ect.).
  • "=": pair([array of 2]) Checks if the column(first value) value is = to the second value.

Member Function Documentation

dismiss (   $unDismiss = false)
Parameters
boolean$unDismissIf this should set this notification to not dismissed.
email ( )

Use this to send the user an email about this notification.

static getRawView (   $injections,
  $level = 1 
)
static
Returns
View object with the $injections injected.

Levels:

  • 1 small: A small quick view of the notification.
    • Rows:
      • "title"
      • "body"
      • "dismissed"
      • "viewed"
      • "date"
      • "user"
      • "label"
    • Injections:
      • "action": An area for actions(buttons) to go.
  • 2 full: The full scale message
    • Rows:
      • "title"
      • "body"
      • "dismissed"
      • "viewed"
      • "date"
      • "user"
      • "label"
    • Injections:
      • "action": An area for actions(buttons) to go.
getUser ( )
Returns
User id
hide ( )

This will set the notification to viewed.

isDismissed ( )
Returns
true if the notification is dismissed or false if not.
show ( )

This will set the notification to not viewed.

The documentation for this interface was generated from the following file: