Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
externallib.php File Reference

Classes

class  core_user_external
 User external functions. More...
 

Functions

static add_user_device ($appid, $name, $model, $platform, $version, $pushid, $uuid, $publickey=null)
 Add a user device in Moodle database (for PUSH notifications usually).
 
static add_user_device_parameters ()
 Returns description of method parameters.
 
static add_user_device_returns ()
 Returns description of method result value.
 
static add_user_private_files ($draftid)
 Copy files from a draft area to users private files area.
 
static add_user_private_files_parameters ()
 Returns description of method parameters.
 
static add_user_private_files_returns ()
 Returns description of method result value.
 
static agree_site_policy ()
 Agree the site policy for the current user.
 
static agree_site_policy_parameters ()
 Returns description of method parameters.
 
static agree_site_policy_returns ()
 Returns description of method result value.
 
static get_course_user_profiles ($userlist)
 Get course participant's details.
 
static get_course_user_profiles_parameters ()
 Returns description of method parameters.
 
static get_course_user_profiles_returns ()
 Returns description of method result value.
 
static get_private_files_info ($userid=0)
 Returns general information about files in the user private files area.
 
static get_private_files_info_parameters ()
 Returns description of method parameters.
 
static get_private_files_info_returns ()
 Returns description of method result value.
 
static get_user_preferences ($name='', $userid=0)
 Return user preferences.
 
static get_user_preferences_parameters ()
 Returns description of method parameters.
 
static get_user_preferences_returns ()
 Returns description of method result value.
 
static get_users ($criteria=array())
 Retrieve matching user.
 
static get_users_by_field_returns ()
 Returns description of method result value.
 
static get_users_parameters ()
 Returns description of get_users() parameters.
 
static get_users_returns ()
 Returns description of get_users result value.
 
static remove_user_device ($uuid, $appid="")
 Remove a user device from the Moodle database (for PUSH notifications usually).
 
static remove_user_device_parameters ()
 Returns description of method parameters.
 
static remove_user_device_returns ()
 Returns description of method result value.
 
static set_user_preferences ($preferences)
 Set user preferences.
 
static set_user_preferences_parameters ()
 Returns description of method parameters.
 
static set_user_preferences_returns ()
 Returns description of method result value.
 
static update_picture ($draftitemid, $delete=false, $userid=0)
 Update or delete the user picture in the site.
 
static update_picture_parameters ()
 Returns description of method parameters.
 
static update_picture_returns ()
 Returns description of method result value.
 
static user_description ($additionalfields=array())
 Create user return value description.
 
static view_user_list ($courseid)
 Trigger the user_list_viewed event.
 
static view_user_list_parameters ()
 Returns description of method parameters.
 
static view_user_list_returns ()
 Returns description of method result value.
 
static view_user_profile ($userid, $courseid=0)
 Trigger the user profile viewed event.
 
static view_user_profile_parameters ()
 Returns description of method parameters.
 
static view_user_profile_returns ()
 Returns description of method result value.