Hierarchy

  • Returns

Properties

advancedfeatures: ReturnsAdvancedfeatures

Advanced features availability

downloadfiles: null | number

1 if users are allowed to download files, 0 if not

firstname: null | string

first name

fullname: null | string

user full name

functions: ReturnsFunctions
lang: null | string

Current language.

lastname: null | string

last name

limitconcurrentlogins: null | number

Number of concurrent sessions allowed

mobilecssurl: null | string

Mobile custom CSS theme

release: null | string

Moodle release number

sitecalendartype: null | string

Calendar type set in the site.

siteid: null | number

Site course ID

sitename: null | string

site name

siteurl: null | string

site url

theme: null | string

Current theme for the user.

uploadfiles: null | number

1 if users are allowed to upload files, 0 if not

usercalendartype: null | string

Calendar typed used by the user.

usercanmanageownfiles: null | boolean

true if the user can manage his own files

userhomepage: null | number

the default home page for the user: 0 for the site home, 1 for dashboard

userid: null | number

user id

userissiteadmin: null | boolean

Whether the user is a site admin or not.

usermaxuploadfilesize: null | number

user max upload file size (bytes). -1 means the user can ignore the upload file size

username: null | string

username

userpictureurl: null | string

the user profile picture. Warning: this url is the public URL that only works when forcelogin is set to NO and guestaccess is set to YES. In order to retrieve user profile pictures independently of the Moodle config, replace "pluginfile.php" by "webservice/pluginfile.php?token=WSTOKEN&file=" Of course the user can only see profile picture depending on his/her permissions. Moreover it is recommended to use HTTPS too.

userprivateaccesskey: null | string

Private user access key for fetching files.

userquota: null | number

user quota (bytes). 0 means user can ignore the quota

usersessionscount: null | number

Number of active sessions for current user. Only returned when limitconcurrentlogins is used.

version: null | string

Moodle version number

Generated using TypeDoc