ListOptions
in package
ListOptions Class Doc Comment
Tags
Table of Contents
- $additional_info : string|null
- $additional_info When set to **true**, the full list of user information is returned for each user in the account.
- $alternate_admins_only : string|null
- $alternate_admins_only
- $count : string|null
- $count Number of records to return. The number must be greater than 0 and less than or equal to 100.
- $domain_users_only : string|null
- $domain_users_only
- $email : string|null
- $email_substring : string|null
- $email_substring Filters the returned user records by the email address or a sub-string of email address.
- $group_id : string|null
- $group_id Filters user records returned by one or more group Id's.
- $include_usersettings_for_csv : string|null
- $include_usersettings_for_csv
- $login_status : string|null
- $login_status
- $not_group_id : string|null
- $not_group_id
- $start_position : string|null
- $start_position Starting value for the list.
- $status : string|null
- $status
- $user_name_substring : string|null
- $user_name_substring Filters the user records returned by the user name or a sub-string of user name.
- getAdditionalInfo() : string|null
- Gets additional_info
- getAlternateAdminsOnly() : string|null
- Gets alternate_admins_only
- getCount() : string|null
- Gets count
- getDomainUsersOnly() : string|null
- Gets domain_users_only
- getEmail() : string|null
- Gets email
- getEmailSubstring() : string|null
- Gets email_substring
- getGroupId() : string|null
- Gets group_id
- getIncludeUsersettingsForCsv() : string|null
- Gets include_usersettings_for_csv
- getLoginStatus() : string|null
- Gets login_status
- getNotGroupId() : string|null
- Gets not_group_id
- getStartPosition() : string|null
- Gets start_position
- getStatus() : string|null
- Gets status
- getUserNameSubstring() : string|null
- Gets user_name_substring
- setAdditionalInfo() : self
- Sets additional_info
- setAlternateAdminsOnly() : self
- Sets alternate_admins_only
- setCount() : self
- Sets count
- setDomainUsersOnly() : self
- Sets domain_users_only
- setEmail() : self
- Sets email
- setEmailSubstring() : self
- Sets email_substring
- setGroupId() : self
- Sets group_id
- setIncludeUsersettingsForCsv() : self
- Sets include_usersettings_for_csv
- setLoginStatus() : self
- Sets login_status
- setNotGroupId() : self
- Sets not_group_id
- setStartPosition() : self
- Sets start_position
- setStatus() : self
- Sets status
- setUserNameSubstring() : self
- Sets user_name_substring
Properties
$additional_info
$additional_info When set to **true**, the full list of user information is returned for each user in the account.
protected
string|null
$additional_info
= null
$alternate_admins_only
$alternate_admins_only
protected
string|null
$alternate_admins_only
= null
$count
$count Number of records to return. The number must be greater than 0 and less than or equal to 100.
protected
string|null
$count
= null
$domain_users_only
$domain_users_only
protected
string|null
$domain_users_only
= null
protected
string|null
$email
= null
$email_substring
$email_substring Filters the returned user records by the email address or a sub-string of email address.
protected
string|null
$email_substring
= null
$group_id
$group_id Filters user records returned by one or more group Id's.
protected
string|null
$group_id
= null
$include_usersettings_for_csv
$include_usersettings_for_csv
protected
string|null
$include_usersettings_for_csv
= null
$login_status
$login_status
protected
string|null
$login_status
= null
$not_group_id
$not_group_id
protected
string|null
$not_group_id
= null
$start_position
$start_position Starting value for the list.
protected
string|null
$start_position
= null
$status
$status
protected
string|null
$status
= null
$user_name_substring
$user_name_substring Filters the user records returned by the user name or a sub-string of user name.
protected
string|null
$user_name_substring
= null
Methods
getAdditionalInfo()
Gets additional_info
public
getAdditionalInfo() : string|null
Return values
string|null —getAlternateAdminsOnly()
Gets alternate_admins_only
public
getAlternateAdminsOnly() : string|null
Return values
string|null —getCount()
Gets count
public
getCount() : string|null
Return values
string|null —getDomainUsersOnly()
Gets domain_users_only
public
getDomainUsersOnly() : string|null
Return values
string|null —getEmail()
Gets email
public
getEmail() : string|null
Return values
string|null —getEmailSubstring()
Gets email_substring
public
getEmailSubstring() : string|null
Return values
string|null —getGroupId()
Gets group_id
public
getGroupId() : string|null
Return values
string|null —getIncludeUsersettingsForCsv()
Gets include_usersettings_for_csv
public
getIncludeUsersettingsForCsv() : string|null
Return values
string|null —getLoginStatus()
Gets login_status
public
getLoginStatus() : string|null
Return values
string|null —getNotGroupId()
Gets not_group_id
public
getNotGroupId() : string|null
Return values
string|null —getStartPosition()
Gets start_position
public
getStartPosition() : string|null
Return values
string|null —getStatus()
Gets status
public
getStatus() : string|null
Return values
string|null —getUserNameSubstring()
Gets user_name_substring
public
getUserNameSubstring() : string|null
Return values
string|null —setAdditionalInfo()
Sets additional_info
public
setAdditionalInfo(string|null $additional_info) : self
Parameters
- $additional_info : string|null
-
When set to true, the full list of user information is returned for each user in the account.
Return values
self —setAlternateAdminsOnly()
Sets alternate_admins_only
public
setAlternateAdminsOnly(string|null $alternate_admins_only) : self
Parameters
- $alternate_admins_only : string|null
Return values
self —setCount()
Sets count
public
setCount(string|null $count) : self
Parameters
- $count : string|null
-
Number of records to return. The number must be greater than 0 and less than or equal to 100.
Return values
self —setDomainUsersOnly()
Sets domain_users_only
public
setDomainUsersOnly(string|null $domain_users_only) : self
Parameters
- $domain_users_only : string|null
Return values
self —setEmail()
Sets email
public
setEmail(string|null $email) : self
Parameters
- $email : string|null
Return values
self —setEmailSubstring()
Sets email_substring
public
setEmailSubstring(string|null $email_substring) : self
Parameters
- $email_substring : string|null
-
Filters the returned user records by the email address or a sub-string of email address.
Return values
self —setGroupId()
Sets group_id
public
setGroupId(string|null $group_id) : self
Parameters
- $group_id : string|null
-
Filters user records returned by one or more group Id's.
Return values
self —setIncludeUsersettingsForCsv()
Sets include_usersettings_for_csv
public
setIncludeUsersettingsForCsv(string|null $include_usersettings_for_csv) : self
Parameters
- $include_usersettings_for_csv : string|null
Return values
self —setLoginStatus()
Sets login_status
public
setLoginStatus(string|null $login_status) : self
Parameters
- $login_status : string|null
Return values
self —setNotGroupId()
Sets not_group_id
public
setNotGroupId(string|null $not_group_id) : self
Parameters
- $not_group_id : string|null
Return values
self —setStartPosition()
Sets start_position
public
setStartPosition(string|null $start_position) : self
Parameters
- $start_position : string|null
-
Starting value for the list.
Return values
self —setStatus()
Sets status
public
setStatus(string|null $status) : self
Parameters
- $status : string|null
Return values
self —setUserNameSubstring()
Sets user_name_substring
public
setUserNameSubstring(string|null $user_name_substring) : self
Parameters
- $user_name_substring : string|null
-
Filters the user records returned by the user name or a sub-string of user name.