Viewing file:  ChannelOptions.php (16.48 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;
use Twilio\Options;
use Twilio\Values;
abstract class ChannelOptions {
/**
* @param string $xTwilioWebhookEnabled The X-Twilio-Webhook-Enabled HTTP
* request header
* @return DeleteChannelOptions Options builder
*/
public static function delete(string $xTwilioWebhookEnabled = Values::NONE): DeleteChannelOptions {
return new DeleteChannelOptions($xTwilioWebhookEnabled);
}
/**
* @param string $friendlyName A string to describe the new resource
* @param string $uniqueName An application-defined string that uniquely
* identifies the Channel resource
* @param string $attributes A valid JSON string that contains
* application-specific data
* @param string $type The visibility of the channel
* @param \DateTime $dateCreated The ISO 8601 date and time in GMT when the
* resource was created
* @param \DateTime $dateUpdated The ISO 8601 date and time in GMT when the
* resource was updated
* @param string $createdBy The identity of the User that created the Channel
* @param string $xTwilioWebhookEnabled The X-Twilio-Webhook-Enabled HTTP
* request header
* @return CreateChannelOptions Options builder
*/
public static function create(string $friendlyName = Values::NONE, string $uniqueName = Values::NONE, string $attributes = Values::NONE, string $type = Values::NONE, \DateTime $dateCreated = Values::NONE, \DateTime $dateUpdated = Values::NONE, string $createdBy = Values::NONE, string $xTwilioWebhookEnabled = Values::NONE): CreateChannelOptions {
return new CreateChannelOptions($friendlyName, $uniqueName, $attributes, $type, $dateCreated, $dateUpdated, $createdBy, $xTwilioWebhookEnabled);
}
/**
* @param string[] $type The visibility of the channel to read
* @return ReadChannelOptions Options builder
*/
public static function read(array $type = Values::ARRAY_NONE): ReadChannelOptions {
return new ReadChannelOptions($type);
}
/**
* @param string $friendlyName A string to describe the resource
* @param string $uniqueName An application-defined string that uniquely
* identifies the resource
* @param string $attributes A valid JSON string that contains
* application-specific data
* @param \DateTime $dateCreated The ISO 8601 date and time in GMT when the
* resource was created
* @param \DateTime $dateUpdated The ISO 8601 date and time in GMT when the
* resource was updated
* @param string $createdBy The identity of the User that created the Channel
* @param string $xTwilioWebhookEnabled The X-Twilio-Webhook-Enabled HTTP
* request header
* @return UpdateChannelOptions Options builder
*/
public static function update(string $friendlyName = Values::NONE, string $uniqueName = Values::NONE, string $attributes = Values::NONE, \DateTime $dateCreated = Values::NONE, \DateTime $dateUpdated = Values::NONE, string $createdBy = Values::NONE, string $xTwilioWebhookEnabled = Values::NONE): UpdateChannelOptions {
return new UpdateChannelOptions($friendlyName, $uniqueName, $attributes, $dateCreated, $dateUpdated, $createdBy, $xTwilioWebhookEnabled);
}
}
class DeleteChannelOptions extends Options {
/**
* @param string $xTwilioWebhookEnabled The X-Twilio-Webhook-Enabled HTTP
* request header
*/
public function __construct(string $xTwilioWebhookEnabled = Values::NONE) {
$this->options['xTwilioWebhookEnabled'] = $xTwilioWebhookEnabled;
}
/**
* The X-Twilio-Webhook-Enabled HTTP request header
*
* @param string $xTwilioWebhookEnabled The X-Twilio-Webhook-Enabled HTTP
* request header
* @return $this Fluent Builder
*/
public function setXTwilioWebhookEnabled(string $xTwilioWebhookEnabled): self {
$this->options['xTwilioWebhookEnabled'] = $xTwilioWebhookEnabled;
return $this;
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString(): string {
$options = \http_build_query(Values::of($this->options), '', ' ');
return '[Twilio.Chat.V2.DeleteChannelOptions ' . $options . ']';
}
}
class CreateChannelOptions extends Options {
/**
* @param string $friendlyName A string to describe the new resource
* @param string $uniqueName An application-defined string that uniquely
* identifies the Channel resource
* @param string $attributes A valid JSON string that contains
* application-specific data
* @param string $type The visibility of the channel
* @param \DateTime $dateCreated The ISO 8601 date and time in GMT when the
* resource was created
* @param \DateTime $dateUpdated The ISO 8601 date and time in GMT when the
* resource was updated
* @param string $createdBy The identity of the User that created the Channel
* @param string $xTwilioWebhookEnabled The X-Twilio-Webhook-Enabled HTTP
* request header
*/
public function __construct(string $friendlyName = Values::NONE, string $uniqueName = Values::NONE, string $attributes = Values::NONE, string $type = Values::NONE, \DateTime $dateCreated = Values::NONE, \DateTime $dateUpdated = Values::NONE, string $createdBy = Values::NONE, string $xTwilioWebhookEnabled = Values::NONE) {
$this->options['friendlyName'] = $friendlyName;
$this->options['uniqueName'] = $uniqueName;
$this->options['attributes'] = $attributes;
$this->options['type'] = $type;
$this->options['dateCreated'] = $dateCreated;
$this->options['dateUpdated'] = $dateUpdated;
$this->options['createdBy'] = $createdBy;
$this->options['xTwilioWebhookEnabled'] = $xTwilioWebhookEnabled;
}
/**
* A descriptive string that you create to describe the new resource. It can be up to 64 characters long.
*
* @param string $friendlyName A string to describe the new resource
* @return $this Fluent Builder
*/
public function setFriendlyName(string $friendlyName): self {
$this->options['friendlyName'] = $friendlyName;
return $this;
}
/**
* An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the Channel resource's `sid` in the URL. This value must be 64 characters or less in length and be unique within the Service.
*
* @param string $uniqueName An application-defined string that uniquely
* identifies the Channel resource
* @return $this Fluent Builder
*/
public function setUniqueName(string $uniqueName): self {
$this->options['uniqueName'] = $uniqueName;
return $this;
}
/**
* A valid JSON string that contains application-specific data.
*
* @param string $attributes A valid JSON string that contains
* application-specific data
* @return $this Fluent Builder
*/
public function setAttributes(string $attributes): self {
$this->options['attributes'] = $attributes;
return $this;
}
/**
* The visibility of the channel. Can be: `public` or `private` and defaults to `public`.
*
* @param string $type The visibility of the channel
* @return $this Fluent Builder
*/
public function setType(string $type): self {
$this->options['type'] = $type;
return $this;
}
/**
* The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this should only be used in cases where a Channel is being recreated from a backup/separate source.
*
* @param \DateTime $dateCreated The ISO 8601 date and time in GMT when the
* resource was created
* @return $this Fluent Builder
*/
public function setDateCreated(\DateTime $dateCreated): self {
$this->options['dateCreated'] = $dateCreated;
return $this;
}
/**
* The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated. The default value is `null`. Note that this parameter should only be used in cases where a Channel is being recreated from a backup/separate source and where a Message was previously updated.
*
* @param \DateTime $dateUpdated The ISO 8601 date and time in GMT when the
* resource was updated
* @return $this Fluent Builder
*/
public function setDateUpdated(\DateTime $dateUpdated): self {
$this->options['dateUpdated'] = $dateUpdated;
return $this;
}
/**
* The `identity` of the User that created the channel. Default is: `system`.
*
* @param string $createdBy The identity of the User that created the Channel
* @return $this Fluent Builder
*/
public function setCreatedBy(string $createdBy): self {
$this->options['createdBy'] = $createdBy;
return $this;
}
/**
* The X-Twilio-Webhook-Enabled HTTP request header
*
* @param string $xTwilioWebhookEnabled The X-Twilio-Webhook-Enabled HTTP
* request header
* @return $this Fluent Builder
*/
public function setXTwilioWebhookEnabled(string $xTwilioWebhookEnabled): self {
$this->options['xTwilioWebhookEnabled'] = $xTwilioWebhookEnabled;
return $this;
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString(): string {
$options = \http_build_query(Values::of($this->options), '', ' ');
return '[Twilio.Chat.V2.CreateChannelOptions ' . $options . ']';
}
}
class ReadChannelOptions extends Options {
/**
* @param string[] $type The visibility of the channel to read
*/
public function __construct(array $type = Values::ARRAY_NONE) {
$this->options['type'] = $type;
}
/**
* The visibility of the Channels to read. Can be: `public` or `private` and defaults to `public`.
*
* @param string[] $type The visibility of the channel to read
* @return $this Fluent Builder
*/
public function setType(array $type): self {
$this->options['type'] = $type;
return $this;
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString(): string {
$options = \http_build_query(Values::of($this->options), '', ' ');
return '[Twilio.Chat.V2.ReadChannelOptions ' . $options . ']';
}
}
class UpdateChannelOptions extends Options {
/**
* @param string $friendlyName A string to describe the resource
* @param string $uniqueName An application-defined string that uniquely
* identifies the resource
* @param string $attributes A valid JSON string that contains
* application-specific data
* @param \DateTime $dateCreated The ISO 8601 date and time in GMT when the
* resource was created
* @param \DateTime $dateUpdated The ISO 8601 date and time in GMT when the
* resource was updated
* @param string $createdBy The identity of the User that created the Channel
* @param string $xTwilioWebhookEnabled The X-Twilio-Webhook-Enabled HTTP
* request header
*/
public function __construct(string $friendlyName = Values::NONE, string $uniqueName = Values::NONE, string $attributes = Values::NONE, \DateTime $dateCreated = Values::NONE, \DateTime $dateUpdated = Values::NONE, string $createdBy = Values::NONE, string $xTwilioWebhookEnabled = Values::NONE) {
$this->options['friendlyName'] = $friendlyName;
$this->options['uniqueName'] = $uniqueName;
$this->options['attributes'] = $attributes;
$this->options['dateCreated'] = $dateCreated;
$this->options['dateUpdated'] = $dateUpdated;
$this->options['createdBy'] = $createdBy;
$this->options['xTwilioWebhookEnabled'] = $xTwilioWebhookEnabled;
}
/**
* A descriptive string that you create to describe the resource. It can be up to 256 characters long.
*
* @param string $friendlyName A string to describe the resource
* @return $this Fluent Builder
*/
public function setFriendlyName(string $friendlyName): self {
$this->options['friendlyName'] = $friendlyName;
return $this;
}
/**
* An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. This value must be 256 characters or less in length and unique within the Service.
*
* @param string $uniqueName An application-defined string that uniquely
* identifies the resource
* @return $this Fluent Builder
*/
public function setUniqueName(string $uniqueName): self {
$this->options['uniqueName'] = $uniqueName;
return $this;
}
/**
* A valid JSON string that contains application-specific data.
*
* @param string $attributes A valid JSON string that contains
* application-specific data
* @return $this Fluent Builder
*/
public function setAttributes(string $attributes): self {
$this->options['attributes'] = $attributes;
return $this;
}
/**
* The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this should only be used in cases where a Channel is being recreated from a backup/separate source.
*
* @param \DateTime $dateCreated The ISO 8601 date and time in GMT when the
* resource was created
* @return $this Fluent Builder
*/
public function setDateCreated(\DateTime $dateCreated): self {
$this->options['dateCreated'] = $dateCreated;
return $this;
}
/**
* The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated.
*
* @param \DateTime $dateUpdated The ISO 8601 date and time in GMT when the
* resource was updated
* @return $this Fluent Builder
*/
public function setDateUpdated(\DateTime $dateUpdated): self {
$this->options['dateUpdated'] = $dateUpdated;
return $this;
}
/**
* The `identity` of the User that created the channel. Default is: `system`.
*
* @param string $createdBy The identity of the User that created the Channel
* @return $this Fluent Builder
*/
public function setCreatedBy(string $createdBy): self {
$this->options['createdBy'] = $createdBy;
return $this;
}
/**
* The X-Twilio-Webhook-Enabled HTTP request header
*
* @param string $xTwilioWebhookEnabled The X-Twilio-Webhook-Enabled HTTP
* request header
* @return $this Fluent Builder
*/
public function setXTwilioWebhookEnabled(string $xTwilioWebhookEnabled): self {
$this->options['xTwilioWebhookEnabled'] = $xTwilioWebhookEnabled;
return $this;
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString(): string {
$options = \http_build_query(Values::of($this->options), '', ' ');
return '[Twilio.Chat.V2.UpdateChannelOptions ' . $options . ']';
}
}
|