Link to this section Summary

t() :: %Polyjuice.Client.Endpoint.HttpSpec{
  auth_required: boolean(),
  body: iodata() | {:file, String.t()} | {Enumerable.t(), integer()},
  headers: [{String.t(), String.t()}],
  method: atom(),
  path: String.t(),
  query: Keyword.t() | nil,
  stream_response: boolean()
}

The description of how to handle the endpoint.

method is the HTTP verb
headers is a list of the HTTP headers
path is the path of the endpoint, relative to the homeserver's base URL
query is an enumerable of {key, value} tuples giving the query parameters
body is the HTTP body (if any) as a binary, or {:file, filename}
transform is a function to transform the result (status code, headers, content) to a return value
auth_required indicates whether the end point requires authentication

Link to this section Functions

accept_json()

Headers for endpoints that accept JSON.

delete(prefix, path, opts \\ [])

Create a DELETE request.

See get/3.

get(prefix, path, opts \\ [])

Create a GET request.

prefix is a prefix for the path. It can be one of r0 (indicating _matrix/client/r0), unstable (indicating _matrix/client/unstable), media_r0 (indicating _matrix/media/r0), or a string giving any other prefix.

opts is a keyword list giving any of the other parameters for Polyjuice.Client.Endpoint.HttpSpec.t().

post(prefix, path, opts \\ [])

Create a POST request.

See get/3.

prefix_media_r0()

The r0 media URL prefix

prefix_r0()

The r0 client URL prefix

prefix_unstable()

The unstable client URL prefix

put(prefix, path, opts \\ [])

Create a PUT request.

See get/3.

send_json()

Headers for endpoints that send and accept JSON.

v0.4.4

Polyjuice Client v0.4.4 Polyjuice.Client.Endpoint.HttpSpec View Source

Link to this section Summary

Types

Functions

Link to this section Types

t()

Link to this section Functions

accept_json()

delete(prefix, path, opts \\ [])

get(prefix, path, opts \\ [])

post(prefix, path, opts \\ [])

prefix_media_r0()

prefix_r0()

prefix_unstable()

put(prefix, path, opts \\ [])

send_json()