Interface ParamsNotesItem

Hierarchy

  • ParamsNotesItem

Properties

clientnoteid courseid format? publishstate text userid

Properties

clientnoteid

clientnoteid: null | string

your own client id for the note. If this id is provided, the fail message id will be returned to you

courseid

courseid: null | number

course id of the note (in Moodle a note can only be created into a course, even for site and personal notes)

Optional format

format?: null | number

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

publishstate

publishstate: null | string

'personal', 'course' or 'site'

text

text: null | string

the text of the message - text or HTML

userid

userid: null | number

id of the user the note is about

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc