Overview

Namespaces

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

Classes

  • AbstractResponse
  • ContactResponse
  • ContactsResponse
  • CountableResponse
  • ErrorResponse
  • GroupResponse
  • GroupsResponse
  • MessageResponse
  • PointsResponse
  • RawResponse
  • SenderResponse
  • SendersResponse
  • StatusResponse
  • UserResponse
  • UsersResponse

Interfaces

  • Response
  • Overview
  • Namespace
  • Class

Class UserResponse

Class UserResponse

SMSApi\Api\Response\AbstractResponse implements SMSApi\Api\Response\Response
Extended by SMSApi\Api\Response\UserResponse
Namespace: SMSApi\Api\Response
Package: SMSApi\Api\Response
Located at Api/Response/UserResponse.php
Methods summary
public
# __construct( $data )

Parameters

$data

Overrides

SMSApi\Api\Response\AbstractResponse::__construct()
public string
# getUsername( )

Returns the username used to authenticate the user.

Returns the username used to authenticate the user.

Returns

string
The username
public float
# getLimit( )

Returns limit points assigned to the user.

Returns limit points assigned to the user.

Returns

float
Points limit
public float
# getMonthLimit( )

Returns number of points that will be assigned to user account each first day of month.

Returns number of points that will be assigned to user account each first day of month.

Returns

float
Monthly points limit
public boolean
# hasFullAccessSenderNames( )

Returns whether the user has access to main account sender names.

Returns whether the user has access to main account sender names.

Returns

boolean
true if the user has access, false otherwise
public boolean
# hasFullAccessPhoneBook( )

Returns whether the user has access to main account phonebook contacts

Returns whether the user has access to main account phonebook contacts

Returns

boolean
true if the user has access, false otherwise
public Boolean
# isActive( )

Check whether the user is enabled.

Check whether the user is enabled.

Returns

Boolean
true if the user is enabled, false otherwise
public string
# getInfo( )

Returns user description text.

Returns user description text.

Returns

string
Methods inherited from SMSApi\Api\Response\AbstractResponse
decode()
Properties inherited from SMSApi\Api\Response\AbstractResponse
$obj
SMSAPI Api Client API documentation generated by ApiGen