Hierarchy

  • ReturnsItem

Properties

address: null | string

Postal address

auth: null | string

Auth plugins include manual, ldap, etc

calendartype: null | string

Calendar type such as "gregorian", must exist on server

city: null | string

Home city of the user

confirmed: null | boolean

Active user: 1 if confirmed, 0 otherwise

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

An email address - allow email as root@localhost

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

id: null | number

ID of the user

idnumber: null | string

An arbitrary ID code number perhaps from the institution

institution: null | string

institution

interests: null | string

user interests (separated by commas)

lang: null | string

Language code such as "en", must exist on server

lastaccess: null | number

last access to the site (0 if never)

lastname: null | string

The family name of the user

mailformat: null | number

Mail format code is 0 for plain text, 1 for HTML etc

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

suspended: null | boolean

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

theme: null | string

Theme name such as "standard", must exist on server

timezone: null | string

Timezone code such as Australia/Perth, or 99 for default

username: null | string

The username

Generated using TypeDoc