Overview

Namespaces

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

Classes

  • Add
  • Edit
  • Get
  • GetPoints
  • UserList
  • Overview
  • Namespace
  • Class

Class Add

Class Add

SMSApi\Api\Action\AbstractAction
Extended by SMSApi\Api\Action\User\Add

Direct known subclasses

SMSApi\Api\Action\User\Edit
Namespace: SMSApi\Api\Action\User
Package: SMSApi\Api\Action\User
Located at Api/Action/User/Add.php
Methods summary
protected SMSApi\Api\Response\UserResponse
# response( $data )

Parameters

$data

Returns

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

Returns

SMSApi\Proxy\Uri
public
# setUsername( string $username )

New account user name.

New account user name.

Parameters

$username
account name

Returns


$this
public
# setPassword( string $password )

Set account password encoded md5 algorithm.

Set account password encoded md5 algorithm.

Parameters

$password
password encoded md5

Returns


$this
public
# setPasswordApi( string $password )

Set account api password hashed with md5.

Set account api password hashed with md5.

Parameters

$password
password api encoded md5

Returns


$this
public
# setLimit( number $limit )

Set credit limit granted to account.

Set credit limit granted to account.

Parameters

$limit
limit

Returns


$this
public
# setMonthLimit( number $limit )

Set month credits, the amount that will be granted 1st day of every month.

Set month credits, the amount that will be granted 1st day of every month.

Parameters

$limit
limit number

Returns


$this
public
# setFullAccessSenderNames( boolean $access )

Set access to main account sender names.

Set access to main account sender names.

Parameters

$access
if true access is granted

Returns


$this
public
# setFullAccessPhoneBook( boolean $access )

Set access to main account phonebook contacts.

Set access to main account phonebook contacts.

Parameters

$access

Returns


$this
public
# setActive( boolean $val )

Set account active status.

Set account active status.

Parameters

$val
if true set account enable otherwise disabled

Returns


$this
public
# setInfo( string $info )

Set additional account description.

Set additional account description.

Parameters

$info
description

Returns


$this
Methods inherited from SMSApi\Api\Action\AbstractAction
__construct(), 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
SMSAPI Api Client API documentation generated by ApiGen