ExTwilio v0.7.0 ExTwilio.Participant View Source
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")
Link to this section Summary
Functions
Children represent path segments that come after the current resource. For example,
in the path /v2/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users/Active
"Active" is
a child. Children may or may not have a key in the next segment
Parents represent path segments that precede the current resource. For example,
in the path /v2/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users
"Services" is
a parent. Parents will always have a key in the next segment. If your parent is under a
submodule of ExTwilio
, specify your parent using the ExTwilio.Parent
struct
Underscored and lowercased collection name for a given resource.
Delegates the real work to ExTwilio.Api.resource_collection_name/1
by
default
CamelCase resource name as it would be used in Twilio's API. Delegates
the real work to ExTwilio.Api.resource_name/1
by default
Link to this section Functions
all(options \\ []) View Source
children()
View Source
children() :: list()
children() :: list()
Children represent path segments that come after the current resource. For example,
in the path /v2/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users/Active
"Active" is
a child. Children may or may not have a key in the next segment.
Override this method in your resource to specify children in the order that they will appear in the path.
create(data, options \\ [])
View Source
create(ExTwilio.Api.data(), list()) :: ExTwilio.Parser.parsed_response()
create(ExTwilio.Api.data(), list()) :: ExTwilio.Parser.parsed_response()
destroy(sid, options \\ [])
View Source
destroy(String.t(), list()) ::
ExTwilio.Parser.success_delete() | ExTwilio.Parser.error()
destroy(String.t(), list()) :: ExTwilio.Parser.success_delete() | ExTwilio.Parser.error()
do_new(struct, list)
View Source
do_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()
},
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()
}
do_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() }, 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() }
find(sid, options \\ [])
View Source
find(String.t() | nil, list()) :: ExTwilio.Parser.parsed_list_response()
find(String.t() | nil, list()) :: ExTwilio.Parser.parsed_list_response()
new(attrs) View Source
parents()
View Source
parents() :: list()
parents() :: list()
Parents represent path segments that precede the current resource. For example,
in the path /v2/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users
"Services" is
a parent. Parents will always have a key in the next segment. If your parent is under a
submodule of ExTwilio
, specify your parent using the ExTwilio.Parent
struct.
Override this method in your resource to specify parents in the order that they will appear in the path.
resource_collection_name() View Source
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 after use ExTwilio.Resource
if you need
something different.
resource_name() View Source
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 after use ExTwilio.Resource
if you need
something different.
stream(options \\ []) View Source
update(sid, data, options \\ [])
View Source
update(String.t(), ExTwilio.Api.data(), list()) ::
ExTwilio.Parser.parsed_response()
update(String.t(), ExTwilio.Api.data(), list()) :: ExTwilio.Parser.parsed_response()