Back to Seed Clases

Midgard

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Midgard.DBObject
Midgard.User

Class Midgard.User

Import line:	Midgard = imports.gi.Midgard;
GIR File:	Midgard-10.05.gir
C documentation:	MidgardUser
Class :	User
Extends:	Midgard.DBObject
	Show / Hide Inherited methods, properties and signals

Properties
Properties		Defined By
	active : Boolean	Midgard.User
	authtype : String	Midgard.User
	authtypeid : Number read only	Midgard.User
	dbpriv : Midgard.DBObjectPrivate read only	Midgard.DBObject
	guid : String read only	Midgard.User
	login : String	Midgard.User
	parent : Midgard.DBObject read only	Midgard.User
	password : String	Midgard.User
	person : String read only	Midgard.User
	priv : Midgard.UserPrivate read only	Midgard.User
	usertype : Number	Midgard.User

Methods / Constructors
Method / Constructor		Defined By
	new Midgard.User (Object *properties) Create a new Midgard.User Create a new Midgard.User Parameters: Object properties*
	new Midgard.User.c_new (Connection *mgd, Number n_params, Parameter parameters) : Midgard.User Create a new Midgard.User Create a new Midgard.User Parameters: Midgard.Connection mgd* Required (not null) Number n_params Required (not null) GObject.Parameter parameters Required (not null) Returns: Midgard.User
	Midgard.User.get (Connection *mgd, Number n_params, Parameter parameters) : Midgard.User Fetch MidgardUser* object from storage. Fetch MidgardUser object from storage. At least 'login' and 'authtype' property are required to be set in parameters. Cases to return NULL: 'login' or 'authtype' properties do not exist in given parameters (MGD_ERR_INVALID_PROPERTY_VALUE) There's no user object which match given parameters (MGD_ERR_NOT_EXISTS) More than one record found in database (MGD_ERR_INTERNAL) Since 9.09 Parameters: Midgard.Connection mgd Required (not null) Number n_params Required (not null) GObject.Parameter parameters Required (not null) Returns: Midgard.User	Midgard.User
	Midgard.User.query (Connection *mgd, Number n_params, Parameter parameters) : Midgard.User Parameters: Midgard.Connection mgd* Required (not null) Number n_params Required (not null) GObject.Parameter parameters Required (not null) Returns: Midgard.User	Midgard.User
	Midgard.User.quick_login (Connection *mgd, String login, String password) : Midgard.User Parameters: Midgard.Connection mgd* Required (not null) String login Required (not null) String password Required (not null) Returns: Midgard.User	Midgard.User
	create () : Boolean Returns: Boolean	Midgard.User
	delete () : Boolean Delete user's storage record. Delete user's storage record. Cases to return FALSE: User's guid is not set ( MGD_ERR_INVALID_PROPERTY_VALUE ) Failed to delete storage record ( MGD_ERR_INTERNAL ) Returns: Boolean	Midgard.User
	get_person () : Midgard.Object Returned object should not be unref. Returned object should not be unref. Returns: Midgard.Object	Midgard.User
	is_admin () : Boolean Checks if given user is an admin. Checks if given user is an admin. Returns: Boolean	Midgard.User
	is_user () : Boolean Checks if given user is a user. Checks if given user is a user. For example, function will return FALSE for user who is logged in as admin or root. Returns: Boolean	Midgard.User
	log_in () : Boolean Returns: Boolean	Midgard.User
	log_out () : Boolean Cases to return FALSE: There's no user logged in (MGD_ERR_INTERNAL) User is not recently logged in (MGD_ERR_INTERNAL) Cases to return FALSE: There's no user logged in (MGD_ERR_INTERNAL) User is not recently logged in (MGD_ERR_INTERNAL) Returns: Boolean	Midgard.User
	set_active (Boolean *flag) : Boolean Parameters: Boolean flag* Required (not null) Returns: Boolean	Midgard.User
	set_person (Object *person) : Boolean Associates given MidgardObject* person with self MidgardUser. Associates given MidgardObject person with self MidgardUser. Sets person property and updates user storage record. MidgardUser self takes ownership of the given MidgardPerson reference, which should be not unref any more. See midgard_user_update() for returned error details. Parameters: Midgard.Object person Required (not null) Returns: Boolean	Midgard.User
	update () : Boolean Updates user storage record Cases to return FALSE: User with such login and authentication type already exists ( MGD_ERR_DUPLICATE ) User's guid is not set ( MGD_ERR_INVALID_PROPERTY_VALUE ) 'authtype' property is empty or NULL ( MGD_ERR_INVALID_PROPERTY_VALUE ) User record hasn't been found ( MGD_ERR_INTERNAL ) Failed to update storage record ( MGD_ERR_INTERNAL ) 'authtype' property value is invalid ( MGD_ERR_INTERNAL ) Updates user storage record Cases to return FALSE: User with such login and authentication type already exists ( MGD_ERR_DUPLICATE ) User's guid is not set ( MGD_ERR_INVALID_PROPERTY_VALUE ) 'authtype' property is empty or NULL ( MGD_ERR_INVALID_PROPERTY_VALUE ) User record hasn't been found ( MGD_ERR_INTERNAL ) Failed to update storage record ( MGD_ERR_INTERNAL ) 'authtype' property value is invalid ( MGD_ERR_INTERNAL ) Returns: Boolean	Midgard.User

Events
None

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Midgard.Connection Method	get_user () : Midgard.User NULL is explicitly returned if there's no midgard_user logged in for the given MidgardConnection.

Documentation generated by Introspection Doc Generator Loosely Based on JsDoc Toolkit on Tue Jun 22 2010 16:34:51 GMT+0800 (HKT)