TwitchApi.ApiJson.Template.Method.Headers (TwitchApi v0.1.2) View Source

Provides the methods headers template for a twitch api item module

Link to this section Summary

Functions

Configures the headers for the Finch request

Configures the OAuth headers for the Finch request

Provides the twitch api Elixir headers method for a twitch api item

Parses the twitch api Elixir get_headers method for a twitch api item. If its an OAuth header it config the needed method type spec.

Parses the twitch api Elixir get_headers method for a twitch api item. If its an OAuth header it config the needed method param.

Parses the twitch api Elixir body_params method for a twitch api item

Parses body specs from a twitch api item

Link to this section Functions

Specs

config_headers() :: headers :: [{binary(), binary()}]

Configures the headers for the Finch request

Link to this function

config_oauth_headers(map)

View Source

Specs

config_oauth_headers(map()) :: headers :: [{binary(), binary()}]

Configures the OAuth headers for the Finch request

Specs

get_headers(TwitchApi.ApiJson.Item.t()) :: String.t() | :not_supported | :oauth

Provides the twitch api Elixir headers method for a twitch api item

Link to this function

get_oauth_type_spec(headers)

View Source

Specs

get_oauth_type_spec(String.t()) ::
  {[type_spec :: String.t()], method_param :: String.t()}

Parses the twitch api Elixir get_headers method for a twitch api item. If its an OAuth header it config the needed method type spec.

Link to this function

parse_get_headers(headers)

View Source

Specs

parse_get_headers(String.t()) :: parsed_get_headers :: String.t()

Parses the twitch api Elixir get_headers method for a twitch api item. If its an OAuth header it config the needed method param.

Link to this function

parse_method_params(method_params, headers)

View Source

Specs

parse_method_params(String.t(), String.t()) ::
  parsed_method_params :: String.t()

Parses the twitch api Elixir body_params method for a twitch api item

Link to this function

parse_method_specs(specs, headers)

View Source

Specs

parse_method_specs(String.t(), String.t()) :: parsed_method_params :: String.t()

Parses body specs from a twitch api item