ItsfoundPostage.Api.Helpers (itsfound_postage v0.1.0) View Source
Link to this section Summary
Types
List of options to all request functions.
Result returned from request!/3
, get!/2
, post!/2
, put!/2
, etc.
Functions
A shortcut for request(:delete, url, options)
.
A shortcut for request!(:delete, url, options)
.
A shortcut for request(:get, url, options)
.
A shortcut for request!(:get, url, options)
.
A shortcut for request(:head, url, options)
.
A shortcut for request!(:head, url, options)
.
A shortcut for request(:options, url, options)
.
A shortcut for request!(:options, url, options)
.
A shortcut for request(:patch, url, options)
.
A shortcut for request!(:patch, url, options)
.
A shortcut for request(:post, url, options)
.
A shortcut for request!(:post, url, options)
.
A shortcut for request(:put, url, options)
.
A shortcut for request!(:put, url, options)
.
Sends an HTTP request.
Like request/3
, but raises HTTPotion.HTTPError
if failed.
Starts a linked worker process for use with the direct
option.
Starts a worker process for use with the direct
option.
Ensures that HTTPotion and its dependencies are started.
Stops a worker process started with spawn_worker_process/2
or spawn_link_worker_process/2
.
Link to this section Types
Specs
http_opts() :: [ body: binary() | charlist(), headers: [{atom() | String.Chars.t(), String.Chars.t()}], query: %{optional(String.Chars.t()) => String.Chars.t()}, timeout: timeout(), basic_auth: {List.Chars.t(), List.Chars.t()}, stream_to: pid() | port() | atom() | {atom(), node()}, direct: pid() | port() | atom() | {atom(), node()}, ibrowse: keyword(), auto_sni: boolean(), follow_redirects: boolean() ]
List of options to all request functions.
body
- request bodyheaders
- HTTP headers (e.g.["Accept": "application/json"]
)query
- URL query string (e.g.%{page: 1}
)timeout
- timeout in millisecondsbasic_auth
- basic auth credentials (e.g.{"user", "password"}
)stream_to
- if you want to make an async request, reference to the processdirect
- if you want to use ibrowse's direct feature, reference tothe worker spawned by `spawn_worker_process/2` or `spawn_link_worker_process/2`
ibrowse
- options for ibrowseauto_sni
- if true and the URL is https, configures theserver_name_indication
ibrowse/ssl optionto be the host part of the requestedURL
follow_redirects
- if true and a response is a redirect, re-requests withheader[:Location]
Specs
http_result() :: HTTPotion.Response.t() | %HTTPotion.AsyncResponse{id: term()} | %HTTPotion.ErrorResponse{message: term()}
Specs
http_result_bang() :: HTTPotion.Response.t() | %HTTPotion.AsyncResponse{id: term()}
Result returned from request!/3
, get!/2
, post!/2
, put!/2
, etc.
Link to this section Functions
Specs
delete(String.Chars.t(), http_opts()) :: http_result()
A shortcut for request(:delete, url, options)
.
Specs
delete!(String.Chars.t(), http_opts()) :: http_result_bang()
A shortcut for request!(:delete, url, options)
.
Specs
get(String.Chars.t(), http_opts()) :: http_result()
A shortcut for request(:get, url, options)
.
Specs
get!(String.Chars.t(), http_opts()) :: http_result_bang()
A shortcut for request!(:get, url, options)
.
Specs
head(String.Chars.t(), http_opts()) :: http_result()
A shortcut for request(:head, url, options)
.
Specs
head!(String.Chars.t(), http_opts()) :: http_result_bang()
A shortcut for request!(:head, url, options)
.
Specs
options(String.Chars.t(), http_opts()) :: http_result()
A shortcut for request(:options, url, options)
.
Specs
options!(String.Chars.t(), http_opts()) :: http_result_bang()
A shortcut for request!(:options, url, options)
.
Specs
patch(String.Chars.t(), http_opts()) :: http_result()
A shortcut for request(:patch, url, options)
.
Specs
patch!(String.Chars.t(), http_opts()) :: http_result_bang()
A shortcut for request!(:patch, url, options)
.
Specs
post(String.Chars.t(), http_opts()) :: http_result()
A shortcut for request(:post, url, options)
.
Specs
post!(String.Chars.t(), http_opts()) :: http_result_bang()
A shortcut for request!(:post, url, options)
.
Specs
put(String.Chars.t(), http_opts()) :: http_result()
A shortcut for request(:put, url, options)
.
Specs
put!(String.Chars.t(), http_opts()) :: http_result_bang()
A shortcut for request!(:put, url, options)
.
Specs
request(atom(), String.Chars.t(), http_opts()) :: http_result()
Sends an HTTP request.
See the type documentation of http_opts
for a description of options.
Specs
request!(atom(), String.Chars.t(), http_opts()) :: http_result_bang()
Like request/3
, but raises HTTPotion.HTTPError
if failed.
request_direct(conn_pid, method, url, body \\ "", headers \\ [], options \\ [])
View SourceStarts a linked worker process for use with the direct
option.
Starts a worker process for use with the direct
option.
Ensures that HTTPotion and its dependencies are started.
Stops a worker process started with spawn_worker_process/2
or spawn_link_worker_process/2
.