Polyjuice Client v0.3.1 Polyjuice.Client.API protocol View Source

Protocol for calling the Matrix client API.

Link to this section Summary

Functions

Call a Matrix client API.

Execute a function in a queue for a room.

Generate a unique transaction ID.

Link to this section Types

Link to this section Functions

Link to this function

call(client_api, endpoint)

View Source

Call a Matrix client API.

This is a lower-level function; generally, clients will want to call one of the higher-level functions from Polyjuice.Client.

Link to this function

room_queue(client_api, room_id, func)

View Source

Execute a function in a queue for a room.

This is to make sure that, for example, messages are sent in order.

Link to this function

stop(client_api, reason \\ :normal, timeout \\ :infinity)

View Source

Stop the client.

Link to this function

transaction_id(client_api)

View Source

Generate a unique transaction ID.