Difference between revisions of "User new"

From Catglobe Wiki
Jump to: navigation, search
(User_new)
(User_new)
Line 11: Line 11:
 
or
 
or
  
array User_new(userTemplateResourceId[, userNameMass])
+
array User_new(''userTemplateResourceId[, userNameMass]'')
  
 
'''Arguments'''  
 
'''Arguments'''  
Line 18: Line 18:
 
*''password'': is a ''string ''expression. It is the user's password, it must follow the common format for passwords  
 
*''password'': is a ''string ''expression. It is the user's password, it must follow the common format for passwords  
 
*''userTemplateResourceId'': is a ''number ''expression. It is the user template's resource id
 
*''userTemplateResourceId'': is a ''number ''expression. It is the user template's resource id
 +
*''userNameMass'': is a ''string ''expression. It is name which user want to include (optional)
  
 
'''Return value'''  
 
'''Return value'''  

Revision as of 09:07, 24 April 2012



User_new

Create a new user object

Syntax

User_new(username, password, userTemplateResourceId)

or

array User_new(userTemplateResourceId[, userNameMass])

Arguments

  • username: is a string expression. It is the user's username, it must follow the common format of usernames
  • password: is a string expression. It is the user's password, it must follow the common format for passwords
  • userTemplateResourceId: is a number expression. It is the user template's resource id
  • userNameMass: is a string expression. It is name which user want to include (optional)

Return value

An array, it is a user object which contains the following items

Index

Data type

Value

USER_RESOURCE_ID

number

Resource id

USER_NAME

string

Username

USER_TEMPLATE_RESOURCE_ID

number

User template's resource id

USER_PASSWORD

string

Password

USER_TIME_REGISTRATION

bool

If time registration is allowed

USER_MAN_HOURS

number

Number of budget hours

USER_CALCULATED_MAN_HOURS

bool

If number of budget hours is calculated on Team tab's settings

USER_PHONE_NUMBER

array

Phone number list

USER_ACCESS_EXPIRATION

aray

Expiration date

USER_PROTECTED_UNTIL

array

Protection deadline

USER_LANGUAGE

string

Language's ISO code

USER_CULTURE

string

Culture's ISO code

USER_EMAIL

string

Email address

USER_FIRST_NAME

string

First name

USER_MIDDLE_NAME

string

Middle name

USER_LAST_NAME

string

Last name

USER_CURRENCY

string

Currency

USER_DISCOUNT

string

Discount

USER_POINT_BALANCE

number

Point balance (read-only)

USER_TIMEZONE

number

Timezone

USER_ADDRESS

string

Address

USER_CITY

string

City

USER_ZIPCODE

string

Zip code

USER_REGION

string

Region

USER_COUNTRY

string

Country's ISO code

USER_POSTBOX

string

Postbox

USER_WEBSITE

string

Website

USER_DELETED

bool

If the user is deleted

USER_DISABLED

bool

If the user is disabled


Example

array userinfo = User_new("phonghh1111","123456",15070738);

print(userinfo);

//Output : {5,0,phonghh1111,15070738,123456,False,0,False,{},{1,1,1,0,0,0,0,1,0},{1,1,1,0,0,0,0,1,0},en-US,en-GB,,,,,,,0,0,,,,,,,,False,False,}


Availability

Version 5.6