Viewing file:  ParticipantList.php (9.97 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
namespace Twilio\Rest\Api\V2010\Account\Conference;
use Twilio\Exceptions\TwilioException;
use Twilio\ListResource;
use Twilio\Options;
use Twilio\Serialize;
use Twilio\Stream;
use Twilio\Values;
use Twilio\Version;
class ParticipantList extends ListResource {
/**
* Construct the ParticipantList
*
* @param Version $version Version that contains the resource
* @param string $accountSid The SID of the Account that created the resource
* @param string $conferenceSid The SID of the conference the participant is in
*/
public function __construct(Version $version, string $accountSid, string $conferenceSid) {
parent::__construct($version);
// Path Solution
$this->solution = ['accountSid' => $accountSid, 'conferenceSid' => $conferenceSid, ];
$this->uri = '/Accounts/' . \rawurlencode($accountSid) . '/Conferences/' . \rawurlencode($conferenceSid) . '/Participants.json';
}
/**
* Create the ParticipantInstance
*
* @param string $from The phone number, Client identifier, or username portion
* of SIP address that made this call.
* @param string $to The phone number, SIP address or Client identifier that
* received this call.
* @param array|Options $options Optional Arguments
* @return ParticipantInstance Created ParticipantInstance
* @throws TwilioException When an HTTP error occurs.
*/
public function create(string $from, string $to, array $options = []): ParticipantInstance {
$options = new Values($options);
$data = Values::of([
'From' => $from,
'To' => $to,
'StatusCallback' => $options['statusCallback'],
'StatusCallbackMethod' => $options['statusCallbackMethod'],
'StatusCallbackEvent' => Serialize::map($options['statusCallbackEvent'], function($e) { return $e; }),
'Label' => $options['label'],
'Timeout' => $options['timeout'],
'Record' => Serialize::booleanToString($options['record']),
'Muted' => Serialize::booleanToString($options['muted']),
'Beep' => $options['beep'],
'StartConferenceOnEnter' => Serialize::booleanToString($options['startConferenceOnEnter']),
'EndConferenceOnExit' => Serialize::booleanToString($options['endConferenceOnExit']),
'WaitUrl' => $options['waitUrl'],
'WaitMethod' => $options['waitMethod'],
'EarlyMedia' => Serialize::booleanToString($options['earlyMedia']),
'MaxParticipants' => $options['maxParticipants'],
'ConferenceRecord' => $options['conferenceRecord'],
'ConferenceTrim' => $options['conferenceTrim'],
'ConferenceStatusCallback' => $options['conferenceStatusCallback'],
'ConferenceStatusCallbackMethod' => $options['conferenceStatusCallbackMethod'],
'ConferenceStatusCallbackEvent' => Serialize::map($options['conferenceStatusCallbackEvent'], function($e) { return $e; }),
'RecordingChannels' => $options['recordingChannels'],
'RecordingStatusCallback' => $options['recordingStatusCallback'],
'RecordingStatusCallbackMethod' => $options['recordingStatusCallbackMethod'],
'SipAuthUsername' => $options['sipAuthUsername'],
'SipAuthPassword' => $options['sipAuthPassword'],
'Region' => $options['region'],
'ConferenceRecordingStatusCallback' => $options['conferenceRecordingStatusCallback'],
'ConferenceRecordingStatusCallbackMethod' => $options['conferenceRecordingStatusCallbackMethod'],
'RecordingStatusCallbackEvent' => Serialize::map($options['recordingStatusCallbackEvent'], function($e) { return $e; }),
'ConferenceRecordingStatusCallbackEvent' => Serialize::map($options['conferenceRecordingStatusCallbackEvent'], function($e) { return $e; }),
'Coaching' => Serialize::booleanToString($options['coaching']),
'CallSidToCoach' => $options['callSidToCoach'],
'JitterBufferSize' => $options['jitterBufferSize'],
'Byoc' => $options['byoc'],
'CallerId' => $options['callerId'],
'CallReason' => $options['callReason'],
'RecordingTrack' => $options['recordingTrack'],
'TimeLimit' => $options['timeLimit'],
'MachineDetection' => $options['machineDetection'],
'MachineDetectionTimeout' => $options['machineDetectionTimeout'],
'MachineDetectionSpeechThreshold' => $options['machineDetectionSpeechThreshold'],
'MachineDetectionSpeechEndThreshold' => $options['machineDetectionSpeechEndThreshold'],
'MachineDetectionSilenceTimeout' => $options['machineDetectionSilenceTimeout'],
'AmdStatusCallback' => $options['amdStatusCallback'],
'AmdStatusCallbackMethod' => $options['amdStatusCallbackMethod'],
]);
$payload = $this->version->create('POST', $this->uri, [], $data);
return new ParticipantInstance(
$this->version,
$payload,
$this->solution['accountSid'],
$this->solution['conferenceSid']
);
}
/**
* Streams ParticipantInstance 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 ParticipantInstance 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 ParticipantInstance[] 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 ParticipantInstance 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 ParticipantPage Page of ParticipantInstance
*/
public function page(array $options = [], $pageSize = Values::NONE, string $pageToken = Values::NONE, $pageNumber = Values::NONE): ParticipantPage {
$options = new Values($options);
$params = Values::of([
'Muted' => Serialize::booleanToString($options['muted']),
'Hold' => Serialize::booleanToString($options['hold']),
'Coaching' => Serialize::booleanToString($options['coaching']),
'PageToken' => $pageToken,
'Page' => $pageNumber,
'PageSize' => $pageSize,
]);
$response = $this->version->page('GET', $this->uri, $params);
return new ParticipantPage($this->version, $response, $this->solution);
}
/**
* Retrieve a specific page of ParticipantInstance records from the API.
* Request is executed immediately
*
* @param string $targetUrl API-generated URL for the requested results page
* @return ParticipantPage Page of ParticipantInstance
*/
public function getPage(string $targetUrl): ParticipantPage {
$response = $this->version->getDomain()->getClient()->request(
'GET',
$targetUrl
);
return new ParticipantPage($this->version, $response, $this->solution);
}
/**
* Constructs a ParticipantContext
*
* @param string $callSid The Call SID or URL encoded label of the participant
* to fetch
*/
public function getContext(string $callSid): ParticipantContext {
return new ParticipantContext(
$this->version,
$this->solution['accountSid'],
$this->solution['conferenceSid'],
$callSid
);
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString(): string {
return '[Twilio.Api.V2010.ParticipantList]';
}
}
|