Viewing file:  MessageList.php (6.62 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
namespace Twilio\Rest\Chat\V2\Service\Channel;
use Twilio\Exceptions\TwilioException;
use Twilio\ListResource;
use Twilio\Options;
use Twilio\Serialize;
use Twilio\Stream;
use Twilio\Values;
use Twilio\Version;
class MessageList extends ListResource {
/**
* Construct the MessageList
*
* @param Version $version Version that contains the resource
* @param string $serviceSid The SID of the Service that the resource is
* associated with
* @param string $channelSid The SID of the Channel the Message resource
* belongs to
*/
public function __construct(Version $version, string $serviceSid, string $channelSid) {
parent::__construct($version);
// Path Solution
$this->solution = ['serviceSid' => $serviceSid, 'channelSid' => $channelSid, ];
$this->uri = '/Services/' . \rawurlencode($serviceSid) . '/Channels/' . \rawurlencode($channelSid) . '/Messages';
}
/**
* Create the MessageInstance
*
* @param array|Options $options Optional Arguments
* @return MessageInstance Created MessageInstance
* @throws TwilioException When an HTTP error occurs.
*/
public function create(array $options = []): MessageInstance {
$options = new Values($options);
$data = Values::of([
'From' => $options['from'],
'Attributes' => $options['attributes'],
'DateCreated' => Serialize::iso8601DateTime($options['dateCreated']),
'DateUpdated' => Serialize::iso8601DateTime($options['dateUpdated']),
'LastUpdatedBy' => $options['lastUpdatedBy'],
'Body' => $options['body'],
'MediaSid' => $options['mediaSid'],
]);
$headers = Values::of(['X-Twilio-Webhook-Enabled' => $options['xTwilioWebhookEnabled'], ]);
$payload = $this->version->create('POST', $this->uri, [], $data, $headers);
return new MessageInstance(
$this->version,
$payload,
$this->solution['serviceSid'],
$this->solution['channelSid']
);
}
/**
* Streams MessageInstance records from the API as a generator stream.
* This operation lazily loads records as efficiently as possible until the
* limit
* is reached.
* The results are returned as a generator, so this operation is memory
* efficient.
*
* @param array|Options $options Optional Arguments
* @param int $limit Upper limit for the number of records to return. stream()
* guarantees to never return more than limit. Default is no
* limit
* @param mixed $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, stream()
* will attempt to read the limit with the most
* efficient page size, i.e. min(limit, 1000)
* @return Stream stream of results
*/
public function stream(array $options = [], int $limit = null, $pageSize = null): Stream {
$limits = $this->version->readLimits($limit, $pageSize);
$page = $this->page($options, $limits['pageSize']);
return $this->version->stream($page, $limits['limit'], $limits['pageLimit']);
}
/**
* Reads MessageInstance records from the API as a list.
* Unlike stream(), this operation is eager and will load `limit` records into
* memory before returning.
*
* @param array|Options $options Optional Arguments
* @param int $limit Upper limit for the number of records to return. read()
* guarantees to never return more than limit. Default is no
* limit
* @param mixed $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)
* @return MessageInstance[] Array of results
*/
public function read(array $options = [], int $limit = null, $pageSize = null): array {
return \iterator_to_array($this->stream($options, $limit, $pageSize), false);
}
/**
* Retrieve a single page of MessageInstance records from the API.
* Request is executed immediately
*
* @param array|Options $options Optional Arguments
* @param mixed $pageSize Number of records to return, defaults to 50
* @param string $pageToken PageToken provided by the API
* @param mixed $pageNumber Page Number, this value is simply for client state
* @return MessagePage Page of MessageInstance
*/
public function page(array $options = [], $pageSize = Values::NONE, string $pageToken = Values::NONE, $pageNumber = Values::NONE): MessagePage {
$options = new Values($options);
$params = Values::of([
'Order' => $options['order'],
'PageToken' => $pageToken,
'Page' => $pageNumber,
'PageSize' => $pageSize,
]);
$response = $this->version->page('GET', $this->uri, $params);
return new MessagePage($this->version, $response, $this->solution);
}
/**
* Retrieve a specific page of MessageInstance records from the API.
* Request is executed immediately
*
* @param string $targetUrl API-generated URL for the requested results page
* @return MessagePage Page of MessageInstance
*/
public function getPage(string $targetUrl): MessagePage {
$response = $this->version->getDomain()->getClient()->request(
'GET',
$targetUrl
);
return new MessagePage($this->version, $response, $this->solution);
}
/**
* Constructs a MessageContext
*
* @param string $sid The SID of the Message resource to fetch
*/
public function getContext(string $sid): MessageContext {
return new MessageContext(
$this->version,
$this->solution['serviceSid'],
$this->solution['channelSid'],
$sid
);
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString(): string {
return '[Twilio.Chat.V2.MessageList]';
}
}
|