Overview

Namespaces

  • PHP
  • SMSApi
    • Api
      • Action
        • Mms
        • Phonebook
        • Sender
        • Sms
        • User
        • Vms
      • Response
    • Exception
    • Proxy
      • Http

Classes

  • ContactAdd
  • ContactDelete
  • ContactEdit
  • ContactGet
  • ContactList
  • GroupAdd
  • GroupDelete
  • GroupEdit
  • GroupGet
  • GroupList
  • Overview
  • Namespace
  • Class
  • Tree

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( mixed $data )

Parameters

$data
mixed
$data

Returns

SMSApi\Api\Response\ContactsResponse
public SMSApi\Proxy\Uri
# uri( )

Returns

SMSApi\Proxy\Uri
public mixed
# filterByPhoneNumber( string|number $number )

Set filter contacts by phone number.

Set filter contacts by phone number.

Parameters

$number
string|number
$number phone number

Returns

mixed
$this
public mixed
# filterByGroup( string $group )

Set filter contacts by group name.

Set filter contacts by group name.

Parameters

$group
string
$group group name

Returns

mixed
$this
public mixed
# filterByGroups( array $groups )

Set filter contacts by group names.

Set filter contacts by group names.

Parameters

$groups
string[]
$group array of group names

Returns

mixed
$this
public mixed
# 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
string
$text search string

Returns

mixed
$this
public mixed
# filterByGender( string $gender )

Set filter by gender.

Set filter by gender.

Parameters

$gender
string
$gender The value of $gender can be: male, female, unknown

Returns

mixed
$this
public mixed
# setOrderBy( string $orderBy )

Set order parameter.

Set order parameter.

Parameters

$orderBy
string
$orderBy The value of $orderBy can be: first_name, last_name

Returns

mixed
$this
public mixed
# setOrderDir( string $orderDir )

Set order direction.

Set order direction.

Parameters

$orderDir
string
$orderDir The value of $orderBy can be: desc, asc

Returns

mixed
$this
public mixed
# setLimit( integer $limit )

Set result limit.

Set result limit.

Parameters

$limit
integer
$limit Max limit is 200 contacts

Returns

mixed
$this
public mixed
# setOffset( integer $offset )

Set result offset.

Set result offset.

Parameters

$offset
integer
$offset

Returns

mixed
$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
API documentation generated by ApiGen 2.8.0