matrix-client-server-api.api.room-participation — matrix-client-server-api r0.3.0

define-filter clj

(define-filter user-id filter)

Upload a new filter. Uploads a new filter definition to the homeserver. Returns a filter ID that may be used in future requests to restrict which events are returned to the client.

define-filter-with-http-info clj

(define-filter-with-http-info user-id filter)

Upload a new filter. Uploads a new filter definition to the homeserver. Returns a filter ID that may be used in future requests to restrict which events are returned to the client.

get-event-context clj

(get-event-context room-id event-id)

(get-event-context room-id event-id optional-params)

Get events and state around the specified event. This API returns a number of events that happened just before and after the specified event. This allows clients to get the context surrounding an event.

get-event-context-with-http-info clj

(get-event-context-with-http-info room-id event-id)

(get-event-context-with-http-info room-id event-id {:keys [limit]})

Get events and state around the specified event. This API returns a number of events that happened just before and after the specified event. This allows clients to get the context surrounding an event.

get-events clj

(get-events)

(get-events optional-params)

Listen on the event stream. This will listen for new events and return them to the caller. This will block until an event is received, or until the timeout is reached.

This endpoint was deprecated in r0 of this specification. Clients should instead call the |/sync|_ API with a since parameter. See the migration guide <https://matrix.org/docs/guides/client-server-migrating-from-v1.html#deprecated-endpoints>_.

get-events-with-http-info clj

(get-events-with-http-info)

(get-events-with-http-info {:keys [from timeout]})

Listen on the event stream. This will listen for new events and return them to the caller. This will block until an event is received, or until the timeout is reached.

This endpoint was deprecated in r0 of this specification. Clients should instead call the |/sync|_ API with a since parameter. See the migration guide <https://matrix.org/docs/guides/client-server-migrating-from-v1.html#deprecated-endpoints>_.

get-filter clj

(get-filter user-id filter-id)

Download a filter

get-filter-with-http-info clj

(get-filter-with-http-info user-id filter-id)

Download a filter

get-joined-members-by-room clj

(get-joined-members-by-room room-id)

Gets the list of currently joined users and their profile data. This API returns a map of MXIDs to member info objects for members of the room. The current user must be in the room for it to work, unless it is an Application Service in which case any of the AS's users must be in the room. This API is primarily for Application Services and should be faster to respond than /members as it can be implemented more efficiently on the server.

get-joined-members-by-room-with-http-info clj

(get-joined-members-by-room-with-http-info room-id)

Gets the list of currently joined users and their profile data. This API returns a map of MXIDs to member info objects for members of the room. The current user must be in the room for it to work, unless it is an Application Service in which case any of the AS's users must be in the room. This API is primarily for Application Services and should be faster to respond than /members as it can be implemented more efficiently on the server.

get-members-by-room clj

(get-members-by-room room-id)

Get the m.room.member events for the room. Get the list of members for this room.

get-members-by-room-with-http-info clj

(get-members-by-room-with-http-info room-id)

Get the m.room.member events for the room. Get the list of members for this room.

get-one-event clj

(get-one-event event-id)

Get a single event by event ID. Get a single event based on event_id. You must have permission to retrieve this event e.g. by being a member in the room for this event.

This endpoint was deprecated in r0 of this specification. Clients should instead call the |/rooms/{roomId}/context/{eventId}|_ API.

get-one-event-with-http-info clj

(get-one-event-with-http-info event-id)

Get a single event by event ID. Get a single event based on event_id. You must have permission to retrieve this event e.g. by being a member in the room for this event.

This endpoint was deprecated in r0 of this specification. Clients should instead call the |/rooms/{roomId}/context/{eventId}|_ API.

get-room-events clj

(get-room-events room-id from dir)

(get-room-events room-id from dir optional-params)

Get a list of events for this room This API returns a list of message and state events for a room. It uses pagination query parameters to paginate history in the room.

get-room-events-with-http-info clj

(get-room-events-with-http-info room-id from dir)

(get-room-events-with-http-info room-id from dir {:keys [to limit filter]})

Get a list of events for this room This API returns a list of message and state events for a room. It uses pagination query parameters to paginate history in the room.

get-room-state clj

(get-room-state room-id)

Get all state events in the current state of a room. Get the state events for the current state of a room.

get-room-state-by-type clj

(get-room-state-by-type room-id event-type)

Get the state identified by the type, with the empty state key. Looks up the contents of a state event in a room. If the user is joined to the room then the state is taken from the current state of the room. If the user has left the room then the state is taken from the state of the room when they left.

This looks up the state event with the empty state key.

get-room-state-by-type-with-http-info clj

(get-room-state-by-type-with-http-info room-id event-type)

Get the state identified by the type, with the empty state key. Looks up the contents of a state event in a room. If the user is joined to the room then the state is taken from the current state of the room. If the user has left the room then the state is taken from the state of the room when they left.

This looks up the state event with the empty state key.

get-room-state-with-http-info clj

(get-room-state-with-http-info room-id)

Get all state events in the current state of a room. Get the state events for the current state of a room.

get-room-state-with-key clj

(get-room-state-with-key room-id event-type state-key)

Get the state identified by the type and key. Looks up the contents of a state event in a room. If the user is joined to the room then the state is taken from the current state of the room. If the user has left the room then the state is taken from the state of the room when they left.

get-room-state-with-key-with-http-info clj

(get-room-state-with-key-with-http-info room-id event-type state-key)

Get the state identified by the type and key. Looks up the contents of a state event in a room. If the user is joined to the room then the state is taken from the current state of the room. If the user has left the room then the state is taken from the state of the room when they left.

initial-sync clj

(initial-sync)

(initial-sync optional-params)

Get the user's current state. This returns the full state for this user, with an optional limit on the number of messages per room to return.

This endpoint was deprecated in r0 of this specification. Clients should instead call the |/sync|_ API with no since parameter. See the migration guide <https://matrix.org/docs/guides/client-server-migrating-from-v1.html#deprecated-endpoints>_.

initial-sync-with-http-info clj

(initial-sync-with-http-info)

(initial-sync-with-http-info {:keys [limit archived]})

Get the user's current state. This returns the full state for this user, with an optional limit on the number of messages per room to return.

This endpoint was deprecated in r0 of this specification. Clients should instead call the |/sync|_ API with no since parameter. See the migration guide <https://matrix.org/docs/guides/client-server-migrating-from-v1.html#deprecated-endpoints>_.

post-receipt clj

(post-receipt room-id receipt-type event-id)

(post-receipt room-id receipt-type event-id optional-params)

Send a receipt for the given event ID. This API updates the marker for the given receipt type to the event ID specified.

post-receipt-with-http-info clj

(post-receipt-with-http-info room-id receipt-type event-id)

(post-receipt-with-http-info room-id receipt-type event-id {:keys [receipt]})

Send a receipt for the given event ID. This API updates the marker for the given receipt type to the event ID specified.

redact-event clj

(redact-event room-id event-id txn-id)

(redact-event room-id event-id txn-id optional-params)

Strips all non-integrity-critical information out of an event. Strips all information out of an event which isn't critical to the integrity of the server-side representation of the room.

This cannot be undone.

Users may redact their own events, and any user with a power level greater than or equal to the redact power level of the room may redact events there.

redact-event-with-http-info clj

(redact-event-with-http-info room-id event-id txn-id)

(redact-event-with-http-info room-id event-id txn-id {:keys [body]})

Strips all non-integrity-critical information out of an event. Strips all information out of an event which isn't critical to the integrity of the server-side representation of the room.

This cannot be undone.

Users may redact their own events, and any user with a power level greater than or equal to the redact power level of the room may redact events there.

room-initial-sync clj

(room-initial-sync room-id)

Snapshot the current state of a room and its most recent messages. Get a copy of the current state and the most recent messages in a room.

This endpoint was deprecated in r0 of this specification. There is no direct replacement; the relevant information is returned by the |/sync|_ API. See the migration guide <https://matrix.org/docs/guides/client-server-migrating-from-v1.html#deprecated-endpoints>_.

room-initial-sync-with-http-info clj

(room-initial-sync-with-http-info room-id)

Snapshot the current state of a room and its most recent messages. Get a copy of the current state and the most recent messages in a room.

This endpoint was deprecated in r0 of this specification. There is no direct replacement; the relevant information is returned by the |/sync|_ API. See the migration guide <https://matrix.org/docs/guides/client-server-migrating-from-v1.html#deprecated-endpoints>_.

send-message clj

(send-message room-id event-type txn-id)

(send-message room-id event-type txn-id optional-params)

Send a message event to the given room. This endpoint is used to send a message event to a room. Message events allow access to historical events and pagination, making them suited for "once-off" activity in a room.

The body of the request should be the content object of the event; the fields in this object will vary depending on the type of event. See Room Events_ for the m. event specification.

send-message-with-http-info clj

(send-message-with-http-info room-id event-type txn-id)

(send-message-with-http-info room-id event-type txn-id {:keys [body]})

Send a message event to the given room. This endpoint is used to send a message event to a room. Message events allow access to historical events and pagination, making them suited for "once-off" activity in a room.

The body of the request should be the content object of the event; the fields in this object will vary depending on the type of event. See Room Events_ for the m. event specification.

set-room-state clj

(set-room-state room-id event-type)

(set-room-state room-id event-type optional-params)

Send a state event to the given room. State events can be sent using this endpoint. This endpoint is equivalent to calling /rooms/{roomId}/state/{eventType}/{stateKey} with an empty stateKey. Previous state events with matching <roomId> and <eventType>, and empty <stateKey>, will be overwritten.

Requests to this endpoint cannot use transaction IDs like other PUT paths because they cannot be differentiated from the state_key. Furthermore, POST is unsupported on state paths.

The body of the request should be the content object of the event; the fields in this object will vary depending on the type of event. See Room Events_ for the m. event specification.

set-room-state-with-http-info clj

(set-room-state-with-http-info room-id event-type)

(set-room-state-with-http-info room-id event-type {:keys [body]})

Send a state event to the given room. State events can be sent using this endpoint. This endpoint is equivalent to calling /rooms/{roomId}/state/{eventType}/{stateKey} with an empty stateKey. Previous state events with matching <roomId> and <eventType>, and empty <stateKey>, will be overwritten.

Requests to this endpoint cannot use transaction IDs like other PUT paths because they cannot be differentiated from the state_key. Furthermore, POST is unsupported on state paths.

The body of the request should be the content object of the event; the fields in this object will vary depending on the type of event. See Room Events_ for the m. event specification.

set-room-state-with-key clj

(set-room-state-with-key room-id event-type state-key)

(set-room-state-with-key room-id event-type state-key optional-params)

Send a state event to the given room. State events can be sent using this endpoint. These events will be overwritten if <room id>, <event type> and <state key> all match.

Requests to this endpoint cannot use transaction IDs like other PUT paths because they cannot be differentiated from the state_key. Furthermore, POST is unsupported on state paths.

The body of the request should be the content object of the event; the fields in this object will vary depending on the type of event. See Room Events_ for the m. event specification.

set-room-state-with-key-with-http-info clj

(set-room-state-with-key-with-http-info room-id event-type state-key)

(set-room-state-with-key-with-http-info room-id
                                        event-type
                                        state-key
                                        {:keys [body]})

Send a state event to the given room. State events can be sent using this endpoint. These events will be overwritten if <room id>, <event type> and <state key> all match.

Requests to this endpoint cannot use transaction IDs like other PUT paths because they cannot be differentiated from the state_key. Furthermore, POST is unsupported on state paths.

The body of the request should be the content object of the event; the fields in this object will vary depending on the type of event. See Room Events_ for the m. event specification.

set-typing clj

(set-typing user-id room-id typing-state)

Informs the server that the user has started or stopped typing. This tells the server that the user is typing for the next N milliseconds where N is the value specified in the timeout key. Alternatively, if typing is false, it tells the server that the user has stopped typing.

set-typing-with-http-info clj

(set-typing-with-http-info user-id room-id typing-state)

Informs the server that the user has started or stopped typing. This tells the server that the user is typing for the next N milliseconds where N is the value specified in the timeout key. Alternatively, if typing is false, it tells the server that the user has stopped typing.

sync clj

(sync)

(sync optional-params)

Synchronise the client's state and receive new messages. Synchronise the client's state with the latest state on the server. Clients use this API when they first log in to get an initial snapshot of the state on the server, and then continue to call this API to get incremental deltas to the state, and to receive new messages.

sync-with-http-info clj

(sync-with-http-info)

(sync-with-http-info {:keys [filter since full-state set-presence timeout]})

Synchronise the client's state and receive new messages. Synchronise the client's state with the latest state on the server. Clients use this API when they first log in to get an initial snapshot of the state on the server, and then continue to call this API to get incremental deltas to the state, and to receive new messages.