message

Hierarchy

  • ReturnsNotificationsItem

Properties

component: null | string

The component that generated the notification

contexturl: null | string

Context URL

contexturlname: null | string

Context URL link name

customdata: null | string

Custom data to be passed to the message processor. The data here is serialised using json_encode().

deleted: null | boolean

notification deletion status

eventtype: null | string

The type of notification

fullmessage: null | string

The message

fullmessageformat: null | number

fullmessage format (1 = HTML, 0 = MOODLE, 2 = PLAIN, or 4 = MARKDOWN

fullmessagehtml: null | string

The message in html

iconurl: null | string

URL for notification icon

id: null | number

Notification id (this is not guaranteed to be unique within this result set)

read: null | boolean

notification read status

shortenedsubject: null | string

The notification subject shortened with ellipsis

smallmessage: null | string

The shorten message

subject: null | string

The notification subject

text: null | string

The message text formated

timecreated: null | number

Time created

timecreatedpretty: null | string

Time created in a pretty format

timeread: null | number

Time read

useridfrom: null | number

User from id

useridto: null | number

User to id

Generated using TypeDoc