Class ContactList

Class ContactList

SMSApi\Api\Action\AbstractAction

Extended by

SMSApi\Api\Action\Phonebook\ContactList

Namespace: SMSApi\Api\Action\Phonebook
Package: SMSApi\Api\Action\Phonebook
Located at Api/Action/Phonebook/ContactList.php

Methods summary
`public`	# `__construct( )` Overrides `SMSApi\Api\Action\AbstractAction::__construct()`
`protected SMSApi\Api\Response\ContactsResponse`	# `response( $data )` Parameters `$data` Returns `SMSApi\Api\Response\ContactsResponse`
`public SMSApi\Proxy\Uri`	# `uri( )` Returns `SMSApi\Proxy\Uri`
`public`	# `filterByPhoneNumber( string\|number $number )` Set filter contacts by phone number. Set filter contacts by phone number. Parameters `$number` phone number Returns $this
`public`	# `filterByGroup( string $group )` Set filter contacts by group name. Set filter contacts by group name. Parameters `$group` group name Returns $this
`public`	# `filterByGroups( array $groups )` Set filter contacts by group names. Set filter contacts by group names. Parameters `$groups` $group array of group names Returns $this
`public`	# `search( string $text )` The result list will contain contacts with given chars string. The result list will contain contacts with given chars string. Parameters `$text` search string Returns $this
`public`	# `filterByGender( string $gender )` Set filter by gender. Set filter by gender. Parameters `$gender` The value of $gender can be: male, female, unknown Returns $this
`public`	# `setOrderBy( string $orderBy )` Set order parameter. Set order parameter. Parameters `$orderBy` The value of $orderBy can be: first_name, last_name Returns $this
`public`	# `setOrderDir( string $orderDir )` Set order direction. Set order direction. Parameters `$orderDir` The value of $orderBy can be: desc, asc Returns $this
`public`	# `setLimit( integer $limit )` Set result limit. Set result limit. Parameters `$limit` Max limit is 200 contacts Returns $this
`public`	# `setOffset( integer $offset )` Set result offset. Set result offset. Parameters `$offset` Returns $this

Methods inherited from SMSApi\Api\Action\AbstractAction
`client(), execute(), file(), handleError(), paramsBasicToQuery(), paramsLoginToQuery(), paramsOther(), proxy(), renderTo(), setJson(), setTest()`

Properties inherited from SMSApi\Api\Action\AbstractAction
`$client, $date, $encoding, $group, $idx, $params, $proxy, $to`