userman ~master (2020-06-09T07:53:37Z)

UserManUserAPI

userman api

Interface suitable for manipulating user information

interface UserManUserAPI {
struct CollectionIndices;
long count [@property getter];
User.ID properties [@property setter];
User.ID testLogin(string name, string password);
User.ID register(string email, string name, string full_name, string password);
User.ID invite(string email, string full_name, string message, bool send_mail);
void activate(string email, string activation_code);
void resendActivation(string email);
void requestPasswordReset(string email);
void resetPassword(string email, string reset_code, string new_password);
User get(User.ID _user);
User getByName(string q);
User getByEmail(string q);
User getByEmailOrName(string q);
User[] getRange(int first_user, int max_count);
void remove(User.ID _user);
void setEmail(User.ID _user, string email);
void setFullName(User.ID _user, string full_name);
void setPassword(User.ID _user, string password);
void setActive(User.ID _user, bool active);
void setBanned(User.ID _user, bool banned);
void setProperty(User.ID _user, string name, Json value);
void removeProperty(User.ID _user, string name);
string[] getGroups(User.ID _user);
}

Members

Functions

activate
void activate(string email, string activation_code)

Activates a user account using an activation code.

get
User get(User.ID _user)

Gets information about a user.

getByEmail
User getByEmail(string q)

Gets information about a user using the e-mail address as the identifier.

getByEmailOrName
User getByEmailOrName(string q)

Gets information about a user using the user name or e-mail address as the identifier.

getByName
User getByName(string q)

Gets information about a user using the user name as the identifier.

getGroups
string[] getGroups(User.ID _user)

Returns the names of all groups the user is in.

getRange
User[] getRange(int first_user, int max_count)

Gets information about a range of users, suitable for pagination.

invite
User.ID invite(string email, string full_name, string message, bool send_mail)

Invites a user.

register
User.ID register(string email, string name, string full_name, string password)

Registers a new user.

remove
void remove(User.ID _user)

Deletes a user account.

removeProperty
deprecated void removeProperty(User.ID _user, string name)

Removes a user account property.

requestPasswordReset
void requestPasswordReset(string email)

Sends an e-mail with a password reset code.

resendActivation
void resendActivation(string email)

Re-sends an e-mail containing the account activation code.

resetPassword
void resetPassword(string email, string reset_code, string new_password)

Sets a new password using a password reset code.

setActive
void setActive(User.ID _user, bool active)

Sets the activation state of a user.

setBanned
void setBanned(User.ID _user, bool banned)

Sets the banned state of a user.

setEmail
void setEmail(User.ID _user, string email)

Updates the e-mail address of a user account.

setFullName
void setFullName(User.ID _user, string full_name)

Updates the display name of a user.

setPassword
void setPassword(User.ID _user, string password)

Sets a new password.

setProperty
deprecated void setProperty(User.ID _user, string name, Json value)

Sets a custom user account property.

testLogin
User.ID testLogin(string name, string password)

Tests a username/e-mail and password combination for validity.

Properties

count
long count [@property getter]

Gets the total number of registered users.

properties
User.ID properties [@property setter]

Accesses the properties of a user.

Structs

CollectionIndices
struct CollectionIndices
Undocumented in source.

Meta

Source

See Implementation

userman api classesfunctionsinterfacesstructs

Page generated by adrdox