ExTwilio v0.1.1 → Overview → ExTwilio → Media

ExTwilio.Media

Represents an Media resource in the Twilio API.

Examples

Since Media belong to a Message in Twilio's API, you must pass a Message SID to each function in this module.

ExTwilio.Media.all(message: "message_sid")
Source

Summary↑

all(options \\ [])

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

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

Find any Media by its Twilio SID
first_page(metadata)

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

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

Retrieve a list of Medias from the API
new()

Creates a new ExTwilio.Media 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 medias, 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 medias, 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 Media records from the Twilio API

Functions

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

Specs:

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

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

Delegates to ExTwilio.Api.all/2.

Examples

medias = ExTwilio.Media.all
Source
children()
(function) # ↑

Specs:

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

Specs:

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

Delegates to ExTwilio.Api.destroy/3.

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

Specs:

Find any Media by its Twilio SID.

Delegates to ExTwilio.Api.find/3.

Examples

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

Specs:

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

Delegates to ExTwilio.Api.fetch_page/2.

Examples

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

Specs:

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

Delegates to ExTwilio.Api.fetch_page/2.

Examples

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

Specs:

Retrieve a list of Medias from the API.

Delegates to ExTwilio.Api.list/2.

Examples

# Successful response
{:ok, medias, metadata} = ExTwilio.Media.list

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

Specs:

  • new :: %ExTwilio.Media{account_sid: term, content_type: term, date_created: term, date_updated: term, parent_sid: term, sid: term, uri: term}

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

Example

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

Specs:

  • new(list) :: %ExTwilio.Media{account_sid: term, content_type: term, date_created: term, date_updated: term, parent_sid: term, sid: term, uri: term}
Source
next_page(metadata)
(function) # ↑

Specs:

Get the next page of medias, 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.Media.list
{:ok, page2, meta} = ExTwilio.Media.next_page(meta)
Source
parents()
(function) # ↑

Specs:

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

Specs:

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

Delegates to ExTwilio.Api.fetch_page/2.

Examples

{:ok, page2, meta} = ExTwilio.Media.list(page: 2)
{:ok, page1, meta} = ExTwilio.Media.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 Media records from the Twilio API.

Delegates to ExTwilio.Api.stream/2.

Source