ListGroupsOptions
in package
ListGroupsOptions Class Doc Comment
Tags
Table of Contents
- $count : string|null
- $count Number of records to return. The number must be greater than 1 and less than or equal to 100.
- $group_type : string|null
- $group_type
- $include_usercount : string|null
- $include_usercount
- $search_text : string|null
- $search_text
- $start_position : string|null
- $start_position Starting value for the list.
- getCount() : string|null
- Gets count
- getGroupType() : string|null
- Gets group_type
- getIncludeUsercount() : string|null
- Gets include_usercount
- getSearchText() : string|null
- Gets search_text
- getStartPosition() : string|null
- Gets start_position
- setCount() : self
- Sets count
- setGroupType() : self
- Sets group_type
- setIncludeUsercount() : self
- Sets include_usercount
- setSearchText() : self
- Sets search_text
- setStartPosition() : self
- Sets start_position
Properties
$count
$count Number of records to return. The number must be greater than 1 and less than or equal to 100.
protected
string|null
$count
= null
$group_type
$group_type
protected
string|null
$group_type
= null
$include_usercount
$include_usercount
protected
string|null
$include_usercount
= null
$search_text
$search_text
protected
string|null
$search_text
= null
$start_position
$start_position Starting value for the list.
protected
string|null
$start_position
= null
Methods
getCount()
Gets count
public
getCount() : string|null
Return values
string|null —getGroupType()
Gets group_type
public
getGroupType() : string|null
Return values
string|null —getIncludeUsercount()
Gets include_usercount
public
getIncludeUsercount() : string|null
Return values
string|null —getSearchText()
Gets search_text
public
getSearchText() : string|null
Return values
string|null —getStartPosition()
Gets start_position
public
getStartPosition() : string|null
Return values
string|null —setCount()
Sets count
public
setCount(string|null $count) : self
Parameters
- $count : string|null
-
Number of records to return. The number must be greater than 1 and less than or equal to 100.
Return values
self —setGroupType()
Sets group_type
public
setGroupType(string|null $group_type) : self
Parameters
- $group_type : string|null
Return values
self —setIncludeUsercount()
Sets include_usercount
public
setIncludeUsercount(string|null $include_usercount) : self
Parameters
- $include_usercount : string|null
Return values
self —setSearchText()
Sets search_text
public
setSearchText(string|null $search_text) : self
Parameters
- $search_text : 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.