\JAuthenticationResponse

Authentication response class, provides an object for storing user and error details

Synopsis

class JAuthenticationResponse {

• // members
• public  $status;
• public  $type;
• public  $error_message;
• public  $username;
• public  $password;
• public  $email;
• public  $fullname;
• public  $birthdate;
• public  $gender;
• public  $postcode;
• public  $country;
• public  $language;
• public  $timezone;
}


Members

public

• $birthdate — string
  The End User's date of birth as YYYY-MM-DD. Any values whose representation uses fewer than the specified number of digits should be zero-padded. The length of this value MUST always be 10. If the End User user does not want to reveal any particular component of this value, it MUST be set to zero.
• $country — string
  The End User's country of residence as specified by ISO3166.
• $email — string
  The email address of the End User as specified in section 3.4.1 of [RFC2822]
• $error_message — string
  The error message
• $fullname — string
  UTF-8 string free text representation of the End User's full name.
• $gender — string
  The End User's gender, "M" for male, "F" for female.
• $language — string
  End User's preferred language as specified by ISO639.
• $password — string
  Any UTF-8 string that the End User wants to use as a password.
• $postcode — string
  UTF-8 string free text that SHOULD conform to the End User's country's postal system.
• $status — string
  Response status (see status codes)
• $timezone — string
  ASCII string from TimeZone database
• $type — string
  The type of authentication that was successful
• $username — string
  Any UTF-8 string that the End User wants to use as a username.