ExGram.Adapter.Maxwell (ex_gram v0.33.0) View Source

HTTP Adapter that uses Maxwell

Link to this section Summary

Functions

GET http method without request body.

GET! http method without request body.

GET! http method without request body.

POST! http method.

POST! http method.

Link to this section Functions

Link to this function

get(conn \\ %Maxwell.Conn{})

View Source

GET http method without request body.

  • conn - %Maxwell.Conn{}

Returns {:ok, %Maxwell.Conn{}} or {:error, reason_term, %Maxwell.Conn{}}.

Link to this function

get!(conn \\ %Maxwell.Conn{})

View Source

GET! http method without request body.

Returns %Maxwell.Conn{} or raise %MaxWell.Error{} when status not in [200..299].

Link to this function

get!(conn, normal_statuses)

View Source

GET! http method without request body.

  • conn - see get/1
  • normal_statuses - the specified status which not raise exception, for example: [200, 201]

Returns %Maxwell.Conn{} or raise %MaxWell.Error{}.

Link to this function

post(conn \\ %Maxwell.Conn{})

View Source

POST method.

  • conn - %Maxwell.Conn{}.

Returns {:ok, %Maxwell.Conn{}} or {:error, reason, %Maxwell.Conn{}}

Link to this function

post!(conn \\ %Maxwell.Conn{})

View Source

POST! http method.

Return %Maxwell.Conn{} or raise %Maxwell.Error{} when status not in [200.299]

Link to this function

post!(conn, normal_statuses)

View Source

POST! http method.

  • conn - see post/1
  • normal_statuses - the specified status which not raise exception, for example: [200, 201]

Returns %Maxwell.Conn{} or raise %MaxWell.Error{}.