Polyjuice Client v0.4.2 API Reference
Modules
Matrix client functions.
Protocol for calling the Matrix client API.
Account related functions.
Attachment related functions.
Set some account_data for the client. https://matrix.org/docs/spec/client_server/r0.6.1#get-matrix-client-r0-user-userid-account-data-type
Download from the media repository.
Get the combined profile information for this user
Get avatar URL for the user.
Get display name for the user.
Retrieve the mapping from room alias to room ID. https://matrix.org/docs/spec/client_server/latest#get-matrix-client-r0-directory-room-roomalias
Paginates events.
Get a room state.
Synchronize the latest events from the server
Who am I?
Create a room with various configuration options https://matrix.org/docs/spec/client_server/r0.5.0#post-matrix-client-r0-createroom
Join a room.
Log in a user
Logs out a session
Upload to the media repository.
Register a user
Leave a room.
Leave a room.
Sets the position of the read marker for a given room, and optionally the read receipt's location. https://matrix.org/docs/spec/client_server/r0.5.0#post-matrix-client-r0-rooms-roomid-read-markers
Update the user's read receipt.
Performs a search for users.
Upload a filter definition.
Matrix client endpoint.
Set some account_data for the client. https://matrix.org/docs/spec/client_server/r0.6.1#put-matrix-client-r0-user-userid-account-data-type
Change avatar URL for the user.
Change display name for the user.
Create a new mapping from room alias to room ID. https://matrix.org/docs/spec/client_server/latest#put-matrix-client-r0-directory-room-roomalias
Send a redaction event to a room.
Send a message event to a room.
Send a state event to a room.
Updates the typing indicator for a user
Build filters.
Create EventFilter
s, RoomEventFilter
s, StateFilter
s, or RoomFilter
s.
Protocol for client event handlers.
A lower-level client than Polyjuice.Client
.
Media-related functions.
Functions for creating messages.
Build a message out of composable parts.
Something that can be turned into a message.
Profile-related functions.
Room-related functions.
Persistent storage for the Matrix client
Storage using Erlang dets.
Storage using Erlang ets. This should only be used for testing.
User directory related functions.
Look up and interpret a server's .well-known
file.
Mix Tasks
Join a room.
Leave a Matrix room.
Log in to a Matrix homeserver.
Log out of a Matrix homeserver.