exhal v4.6.0 ExHal.Navigation
Summary
Functions
Follows a link in a HAL document
Follows all links of a particular rel in a HAL document
Returns {:ok, url}
if a matching link is found or {:error, %ExHal.Error{...}}
if not
Posts data to the named link in a HAL document
PUTs data to the named link in a HAL document
Functions
Follows a link in a HAL document.
Returns {:ok, %ExHal.Document{...}}
if response is successful;
{:error, %ExHal.Error{...}}
if not
Follows all links of a particular rel in a HAL document.
Returns [{:ok, %ExHal.Document{...}}, {:error, %ExHal.Error{...}, ...]
Returns {:ok, url}
if a matching link is found or {:error, %ExHal.Error{...}}
if not.
- a_doc -
ExHal.Document
in which to search for links - name - the rel of the link of interest
- opts
:tmpl_vars
-Map
of variables with which to expand any templates found. Default:%{}
:strict
- true if the existance of multiple matching links should cause a failure. Default:false
Posts data to the named link in a HAL document.
Returns {:ok, %ExHal.Document{...}}
if response is successful and body is HAL;
{:error, %ExHal.Error{...}}
if response is an error if not