Hierarchy

  • ReturnsItem

Properties

address: null | string

Postal address

city: null | string

Home city of the user

country: null | string

Home country code of the user, such as AU or CZ

User custom fields (also known as user profile fields)

department: null | string

department

description: null | string

User profile description

descriptionformat: null | number

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

email: null | string

Email address

Courses where the user is enrolled - limited by which courses the user is able to see

firstaccess: null | number

first access to the site (0 if never)

firstname: null | string

The first name(s) of the user

fullname: null | string

The fullname of the user

grantedextension: null | boolean

have they been granted an extension

groupid: null | number

for group assignments this is the group id

groupname: null | string

for group assignments this is the group name

user groups

id: null | number

ID of the user

idnumber: null | string

The idnumber of the user

institution: null | string

institution

interests: null | string

user interests (separated by commas)

lastaccess: null | number

last access to the site (0 if never)

lastname: null | string

The family name of the user

phone1: null | string

Phone 1

phone2: null | string

Phone 2

Users preferences

profileimageurl: null | string

User image profile URL - big version

profileimageurlsmall: null | string

User image profile URL - small version

recordid: null | number

record id

requiregrading: null | boolean

is their submission waiting for grading

user roles

submissionstatus: null | string

The submission status (new, draft, reopened or submitted). Empty when not submitted.

submitted: null | boolean

have they submitted their assignment

suspended: null | boolean

Suspend user account, either false to enable user login or true to disable it

username: null | string

The username

Generated using TypeDoc