Twilio.Chat.V1.Service.ChannelService (twilio_elixir v0.1.1)

Channels represent chat rooms

Operations: list, create, fetch, update, delete

Summary

Functions

create(client, service_sid, params \\ %{}, opts \\ [])

Operation: CreateChannel | Tags: ChatV1Channel

delete(client, service_sid, sid, opts \\ [])

Operation: DeleteChannel | Tags: ChatV1Channel

fetch(client, service_sid, sid, opts \\ [])

Operation: FetchChannel | Tags: ChatV1Channel

list(client, service_sid, params \\ %{}, opts \\ [])

Operation: ListChannel | Tags: ChatV1Channel

stream(client, service_sid, params \\ %{}, opts \\ [])

Stream: (lazy auto-pagination).

update(client, service_sid, sid, params \\ %{}, opts \\ [])

Operation: UpdateChannel | Tags: ChatV1Channel

Functions

create(client, service_sid, params \\ %{}, opts \\ [])

@spec create(Twilio.Client.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Chat.V1.Service.Channel.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Operation: CreateChannel | Tags: ChatV1Channel

Optional Parameters

Parameter	Type	Description
`Attributes`	string	A valid JSON string that contains application-specific data.

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

`FriendlyName`	string	A descriptive string that you create to describe the new resource. It can be up to 64 characters long.
`Type`	string	Values: `public`, `private`

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| UniqueName | string | 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 64 characters or less in length and be unique within the Service. |

delete(client, service_sid, sid, opts \\ [])

@spec delete(Twilio.Client.t(), String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:ok, map(), map()} | :ok | {:error, Twilio.Error.t()}

Operation: DeleteChannel | Tags: ChatV1Channel

fetch(client, service_sid, sid, opts \\ [])

@spec fetch(Twilio.Client.t(), String.t(), String.t(), keyword()) ::
  {:ok, Twilio.Resources.Chat.V1.Service.Channel.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Operation: FetchChannel | Tags: ChatV1Channel

list(client, service_sid, params \\ %{}, opts \\ [])

@spec list(Twilio.Client.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Page.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Operation: ListChannel | Tags: ChatV1Channel

Query Parameters

Parameter	Type	Description
`Type`	array	The visibility of the Channels to read. Can be: `public` or `private` and defaults to `public`.

stream(client, service_sid, params \\ %{}, opts \\ [])

@spec stream(Twilio.Client.t(), String.t(), map(), keyword()) :: Enumerable.t()

Stream: (lazy auto-pagination).

update(client, service_sid, sid, params \\ %{}, opts \\ [])

@spec update(Twilio.Client.t(), String.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Chat.V1.Service.Channel.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Operation: UpdateChannel | Tags: ChatV1Channel

Optional Parameters

Parameter	Type	Description
`Attributes`	string	A valid JSON string that contains application-specific data.

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| FriendlyName | string | A descriptive string that you create to describe the resource. It can be up to 64 characters long. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength