Docs For Class GetUserByIdRequest

Description

Parameter object for obtaining the set of user fields

The parameters are : (name [type] description)

language [String] : Language 2 letter ISO-code. When not specified the default user language shall be user.
userId [Long] : the user id for which information should be retrieved. When this property is not specified, the user id of the session shall be used. The ws client shall get information about itself.
moduleSessionId [Long] : the module session id

 <complexType name="getUserByIdRequest">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="moduleSessionId" type="{http://www.w3.org/2001/XMLSchema}long"/>
         <element name="userId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="language" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Located in /src/wrapper/GetUserByIdRequest.php (line 27)

Method Summary

GetUserByIdRequest __construct ( $moduleSessionId, $userId, $language)

void getLanguage ()

void getModuleSessionId ()

void getUserId ()

void setLanguage ( $language)

void setLanguageIfNull ( $defaultValue)

void setModuleSessionId ( $moduleSessionId)

void setUserId ( $userId)

void setUserIdIfNull ( $defaultValue)

Methods

Constructor __construct (line 31)

GetUserByIdRequest __construct ( $moduleSessionId, $userId, $language)

$moduleSessionId
$userId
$language

getLanguage (line 58)

access: public

void getLanguage ()

getModuleSessionId (line 36)

access: public

void getModuleSessionId ()

getUserId (line 44)

access: public

void getUserId ()

setLanguage (line 62)

access: public

void setLanguage ( $language)

$language

setLanguageIfNull (line 65)

access: public

void setLanguageIfNull ( $defaultValue)

$defaultValue

setModuleSessionId (line 40)

access: public

void setModuleSessionId ( $moduleSessionId)

$moduleSessionId

setUserId (line 48)

access: public

void setUserId ( $userId)

$userId

setUserIdIfNull (line 52)

access: public

void setUserIdIfNull ( $defaultValue)

$defaultValue