Overview

Namespaces

  • Angelfon
    • SDK
      • Exceptions
      • Http
      • Rest
        • Api
          • V099
            • User

Classes

  • CallContext
  • CallInstance
  • CallList
  • CallOptions
  • CallPage
  • CreateCallOptions
  • CreateSmsOptions
  • ReadCallOptions
  • ReadSmsOptions
  • SmsContext
  • SmsInstance
  • SmsList
  • SmsOptions
  • SmsPage
  • Overview
  • Namespace
  • Class

Class SmsList

Angelfon\SDK\ListResource
Extended by Angelfon\SDK\Rest\Api\V099\User\SmsList
Namespace: Angelfon\SDK\Rest\Api\V099\User
Located at Rest/Api/V099/User/SmsList.php
Methods summary
public
# __construct( Angelfon\SDK\Version $version )

Overrides

Angelfon\SDK\ListResource::__construct()
public
# create( $to, $options = array() )

Create a new Sms instance

Create a new Sms instance

public Angelfon\SDK\Rest\Api\V099\User\SmsContext
# getContext( integer $id )

Construct a SMS context

Construct a SMS context

Parameters

$id
The SMS ID

Returns

Angelfon\SDK\Rest\Api\V099\User\SmsContext
public Angelfon\SDK\Rest\Api\V099\User\SmsInstance[]
# read( array|Options $options = array(), integer $limit = null, mixed $pageSize = null )

Reads SmsInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Reads SmsInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters

$options
Optional Arguments
$limit

Upper limit for the number of records to return. read() guarantees to never return more than limit. Default is no limit

$pageSize

Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, read() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns

Angelfon\SDK\Rest\Api\V099\User\SmsInstance[]
Array of results
public Angelfon\SDK\SmsPage
# page( array|Options $options = array(), mixed $pageSize,…, string $pageToken,…, mixed $pageNumber,… )

Retrieve a single page of SmsInstance records from the API. Request is executed immediately

Retrieve a single page of SmsInstance records from the API. Request is executed immediately

Parameters

$options
Optional Arguments
$pageSize,…
Number of records to return, defaults to 50
$pageToken,…
PageToken provided by the API
$pageNumber,…
Page Number, this value is simply for client state

Returns

Angelfon\SDK\SmsPage
Page of SmsInstance
Methods inherited from Angelfon\SDK\ListResource
__toString()
Properties inherited from Angelfon\SDK\ListResource
$solution, $uri, $version
API documentation generated by ApiGen