ExTwilio v0.1.0 → Overview → ExTwilio → Participant

ExTwilio.Participant

Represents an Participant resource in the Twilio API.

Examples

Since Participants belong to Conferences in the Twilio API, you must pass a conference to each function in this module. For example:

ExTwilio.Participant.list(conference: "conference_sid")
Source

Summary↑

all(options \\ [])

Retrieve all of the Participant records from the Twilio API, paging through all the API response pages
children()
destroy(sid, options \\ [])

Delete any Participant from your Twilio account, using its SID
find(sid, options \\ [])

Find any Participant by its Twilio SID
first_page(metadata)

Get the first page of participants, using metadata from any page's response
last_page(metadata)

Get the last page of participants, using metadta from any page's response
list(options \\ [])

Retrieve a list of Participants from the API
new()

Creates a new ExTwilio.Participant struct. Optionally, you can pass in attributes to set their initial value in the struct
new(attrs)
next_page(metadata)

Get the next page of participants, using the metadata from the previous response. See all/0 for an easy way to get all the records
parents()
previous_page(metadata)

Get the previous page of participants, using metadata from a previous response
resource_collection_name()

Underscored and lowercased collection name for a given resource. Delegates the real work to ExTwilio.Api.resource_collection_name/1 by default
resource_name()

CamelCase resource name as it would be used in Twilio's API. Delegates the real work to ExTwilio.Api.resource_name/1 by default
stream(options \\ [])

Create a stream of all Participant records from the Twilio API
update(sid, data, options \\ [])

Update an Participant in the Twilio API. You can pass it a binary SID as the identifier, or a whole %ExTwilio.Participant{} struct

Functions

all(options \\ [])
(function) # ↑

Specs:

  • all(list) :: [%{}]

Retrieve all of the Participant records from the Twilio API, paging through all the API response pages.

Delegates to ExTwilio.Api.all/2.

Examples

participants = ExTwilio.Participant.all
Source
children()
(function) # ↑

Specs:

  • children :: list
Source
destroy(sid, options \\ [])
(function) # ↑

Specs:

Delete any Participant from your Twilio account, using its SID.

Delegates to ExTwilio.Api.destroy/3.

Source
find(sid, options \\ [])
(function) # ↑

Specs:

Find any Participant by its Twilio SID.

Delegates to ExTwilio.Api.find/3.

Examples

{:ok, participant} = ExTwilio.Participant.find("...")
{:error, msg, http_status} = ExTwilio.Participant.find("...")
Source
first_page(metadata)
(function) # ↑

Specs:

Get the first page of participants, using metadata from any page's response.

Delegates to ExTwilio.Api.fetch_page/2.

Examples

{:ok, page10, meta} = ExTwilio.Participant.list(page: 10)
{:ok, page1, meta}  = ExTwilio.Participant.first_page(meta)
Source
last_page(metadata)
(function) # ↑

Specs:

Get the last page of participants, using metadta from any page's response.

Delegates to ExTwilio.Api.fetch_page/2.

Examples

{:ok, page10, meta}    = ExTwilio.Participant.list(page: 10)
{:ok, last_page, meta} = ExTwilio.Participant.last_page(meta)
Source
list(options \\ [])
(function) # ↑

Specs:

Retrieve a list of Participants from the API.

Delegates to ExTwilio.Api.list/2.

Examples

# Successful response
{:ok, participants, metadata} = ExTwilio.Participant.list

# Error response
{:error, msg, http_code} = ExTwilio.Participant.list
Source
new()
(function) # ↑

Specs:

  • new :: %ExTwilio.Participant{account_sid: term, call_sid: term, conference_sid: term, date_created: term, date_updated: term, end_conference_on_exit: term, muted: term, start_conference_on_enter: term, uri: term}

Creates a new ExTwilio.Participant struct. Optionally, you can pass in attributes to set their initial value in the struct.

Example

%ExTwilio.Participant{} = ExTwilio.Participant.new
%ExTwilio.Participant{sid: "sid"} = ExTwilio.Participant.new(sid: "sid")
Source
new(attrs)
(function) # ↑

Specs:

  • new(list) :: %ExTwilio.Participant{account_sid: term, call_sid: term, conference_sid: term, date_created: term, date_updated: term, end_conference_on_exit: term, muted: term, start_conference_on_enter: term, uri: term}
Source
next_page(metadata)
(function) # ↑

Specs:

Get the next page of participants, using the metadata from the previous response. See all/0 for an easy way to get all the records.

Delegates to ExTwilio.Api.fetch_page/2.

Examples

{:ok, page1, meta} = ExTwilio.Participant.list
{:ok, page2, meta} = ExTwilio.Participant.next_page(meta)
Source
parents()
(function) # ↑

Specs:

  • parents :: list
Source
previous_page(metadata)
(function) # ↑

Specs:

Get the previous page of participants, using metadata from a previous response.

Delegates to ExTwilio.Api.fetch_page/2.

Examples

{:ok, page2, meta} = ExTwilio.Participant.list(page: 2)
{:ok, page1, meta} = ExTwilio.Participant.previous_page(meta)
Source
resource_collection_name()
(function) # ↑

Underscored and lowercased collection name for a given resource. Delegates the real work to ExTwilio.Api.resource_collection_name/1 by default.

Override in your module before use ExTwilio.Resource if you need something different.

Source
resource_name()
(function) # ↑

CamelCase resource name as it would be used in Twilio's API. Delegates the real work to ExTwilio.Api.resource_name/1 by default.

Override in your module before use ExTwilio.Resource if you need something different.

Source
stream(options \\ [])
(function) # ↑

Create a stream of all Participant records from the Twilio API.

Delegates to ExTwilio.Api.stream/2.

Source
update(sid, data, options \\ [])
(function) # ↑

Specs:

Update an Participant in the Twilio API. You can pass it a binary SID as the identifier, or a whole %ExTwilio.Participant{} struct.

Delegates to ExTwilio.Api.update/4.

Examples

{:ok, participant} = ExTwilio.Participant.update(%ExTwilio.Participant{...}, field: "new_value")
{:ok, participant} = ExTwilio.Participant.update("<SID HERE>", field: "new_value")
Source