Class Inx_Api_User

Description

The User object contains information about the actual logged in user.

The User object contains information about the actual logged in user. Copyright (c) 2010 Inxmail GmbH. All Rights Reserved.

  • since: API 1.7.0

Located in /Api/User.php (line 13)


	
			
Method Summary
Inx_Api_User __construct (stdClass $user)
string getCreationDate ()
string getDescription ()
string getEMail ()
string getRealName ()
string getUsername ()
Methods
Constructor __construct (line 22)

This constructor is used internally to create an Inx_Api_User object.

This constructor is used internally to create an Inx_Api_User object.

  • access: public
Inx_Api_User __construct (stdClass $user)
  • stdClass $user: the user data.
getCreationDate (line 77)

Return the creation date of the logged in user as ISO 8601 formatted date string.

Return the creation date of the logged in user as ISO 8601 formatted date string.

  • return: the creation date of the logged in user as ISO 8601 formatted date string.
  • access: public
string getCreationDate ()
getDescription (line 66)

Returns the description of the logged in user.

Returns the description of the logged in user.

  • return: the description of the logged in user.
  • access: public
string getDescription ()
getEMail (line 44)

Returns the email address of the logged in user.

Returns the email address of the logged in user.

  • return: the email address of the logged in user.
  • access: public
string getEMail ()
getRealName (line 55)

Returns the real name of the logged in user.

Returns the real name of the logged in user.

  • return: the real name of the logged in user.
  • access: public
string getRealName ()
getUsername (line 33)

Returns the user name of the logged in user.

Returns the user name of the logged in user.

  • return: the user name of the logged in user.
  • access: public
string getUsername ()

Documentation generated on Thu, 17 Sep 2015 14:27:34 +0200 by phpDocumentor 1.3.2