Pleroma

v1.1.9-10-g42f76306+dev

Pleroma

Pleroma v1.1.9-10-g42f76306+dev Pleroma.HTTP.RequestBuilder View Source

Helper functions for building Tesla requests

Link to this section Summary

Functions

add_optional_params(request, definitions, list)

Add optional parameters to the request

add_param(request, location, key, values)

Add optional parameters to the request

headers(request, header_list)

Add headers to the request

method(request, m)

Specify the request method when building a request

opts(request, options)

Add custom, per-request middleware or adapter options to the request

url(request, u)

Specify the request method when building a request

Link to this section Functions

Link to this function

add_optional_params(request, definitions, list)

View Source 
add_optional_params(map(), %{optional(atom()) => atom()}, keyword()) :: map()

Add optional parameters to the request

Parameters

  • request (Map) - Collected request options
  • definitions (Map) - Map of parameter name to parameter location.
  • options (KeywordList) - The provided optional parameters

Returns

Map

Link to this function

add_param(request, location, key, values)

View Source 
add_param(map(), atom(), atom(), any()) :: map()

Add optional parameters to the request

Parameters

  • request (Map) - Collected request options
  • location (atom) - Where to put the parameter
  • key (atom) - The name of the parameter
  • value (any) - The value of the parameter

Returns

Map

Link to this function

headers(request, header_list)

View Source 
headers(map(), [tuple()]) :: map()

Add headers to the request

Link to this function

method(request, m)

View Source 
method(map(), atom()) :: map()

Specify the request method when building a request

Parameters

  • request (Map) - Collected request options
  • m (atom) - Request method

Returns

Map

Link to this function

opts(request, options)

View Source 
opts(map(), Keyword.t()) :: map()

Add custom, per-request middleware or adapter options to the request

Link to this function

url(request, u)

View Source 
url(map(), String.t()) :: map()

Specify the request method when building a request

Parameters

  • request (Map) - Collected request options
  • u (String) - Request URL

Returns

Map