matrix-client-server-api.api.user-data — matrix-client-server-api r0.3.0

change-password clj

(change-password)

(change-password optional-params)

Changes a user's password. Changes the password for an account on this homeserver.

This API endpoint uses the User-Interactive Authentication API_.

An access token should be submitted to this endpoint if the client has an active session.

The homeserver may change the flows available depending on whether a valid access token is provided.

change-password-with-http-info clj

(change-password-with-http-info)

(change-password-with-http-info {:keys [body]})

Changes a user's password. Changes the password for an account on this homeserver.

This API endpoint uses the User-Interactive Authentication API_.

An access token should be submitted to this endpoint if the client has an active session.

The homeserver may change the flows available depending on whether a valid access token is provided.

deactivate-account clj

(deactivate-account)

(deactivate-account optional-params)

Deactivate a user's account. Deactivate the user's account, removing all ability for the user to login again.

This API endpoint uses the User-Interactive Authentication API_.

An access token should be submitted to this endpoint if the client has an active session.

The homeserver may change the flows available depending on whether a valid access token is provided.

deactivate-account-with-http-info clj

(deactivate-account-with-http-info)

(deactivate-account-with-http-info {:keys [body]})

Deactivate a user's account. Deactivate the user's account, removing all ability for the user to login again.

This API endpoint uses the User-Interactive Authentication API_.

An access token should be submitted to this endpoint if the client has an active session.

The homeserver may change the flows available depending on whether a valid access token is provided.

delete-room-tag clj

(delete-room-tag user-id room-id tag)

Remove a tag from the room. Remove a tag from the room.

delete-room-tag-with-http-info clj

(delete-room-tag-with-http-info user-id room-id tag)

Remove a tag from the room. Remove a tag from the room.

get-account3-pi-ds clj

(get-account3-pi-ds)

Gets a list of a user's third party identifiers. Gets a list of the third party identifiers that the homeserver has associated with the user's account.

This is not the same as the list of third party identifiers bound to the user's Matrix ID in Identity Servers.

Identifiers in this list may be used by the homeserver as, for example, identifiers that it will accept to reset the user's account password.

get-account3-pi-ds-with-http-info clj

(get-account3-pi-ds-with-http-info)

Gets a list of a user's third party identifiers. Gets a list of the third party identifiers that the homeserver has associated with the user's account.

This is not the same as the list of third party identifiers bound to the user's Matrix ID in Identity Servers.

Identifiers in this list may be used by the homeserver as, for example, identifiers that it will accept to reset the user's account password.

get-avatar-url clj

(get-avatar-url user-id)

Get the user's avatar URL. Get the user's avatar URL. This API may be used to fetch the user's own avatar URL or to query the URL of other users; either locally or on remote homeservers.

get-avatar-url-with-http-info clj

(get-avatar-url-with-http-info user-id)

Get the user's avatar URL. Get the user's avatar URL. This API may be used to fetch the user's own avatar URL or to query the URL of other users; either locally or on remote homeservers.

get-display-name clj

(get-display-name user-id)

Get the user's display name. Get the user's display name. This API may be used to fetch the user's own displayname or to query the name of other users; either locally or on remote homeservers.

get-display-name-with-http-info clj

(get-display-name-with-http-info user-id)

Get the user's display name. Get the user's display name. This API may be used to fetch the user's own displayname or to query the name of other users; either locally or on remote homeservers.

get-room-tags clj

(get-room-tags user-id room-id)

List the tags for a room. List the tags set by a user on a room.

get-room-tags-with-http-info clj

(get-room-tags-with-http-info user-id room-id)

List the tags for a room. List the tags set by a user on a room.

get-token-owner clj

(get-token-owner)

Gets information about the owner of an access token. Gets information about the owner of a given access token.

get-token-owner-with-http-info clj

(get-token-owner-with-http-info)

Gets information about the owner of an access token. Gets information about the owner of a given access token.

get-user-profile clj

(get-user-profile user-id)

Get this user's profile information. Get the combined profile information for this user. This API may be used to fetch the user's own profile information or other users; either locally or on remote homeservers. This API may return keys which are not limited to displayname or avatar_url.

get-user-profile-with-http-info clj

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

Get this user's profile information. Get the combined profile information for this user. This API may be used to fetch the user's own profile information or other users; either locally or on remote homeservers. This API may return keys which are not limited to displayname or avatar_url.

post3-pi-ds clj

(post3-pi-ds)

(post3-pi-ds optional-params)

Adds contact information to the user's account. Adds contact information to the user's account.

post3-pi-ds-with-http-info clj

(post3-pi-ds-with-http-info)

(post3-pi-ds-with-http-info {:keys [body]})

Adds contact information to the user's account. Adds contact information to the user's account.

register clj

(register)

(register optional-params)

Register for an account on this homeserver. This API endpoint uses the User-Interactive Authentication API_.

Register for an account on this homeserver.

There are two kinds of user account:

• user accounts. These accounts may use the full API described in this specification.

• guest accounts. These accounts may have limited permissions and may not be supported by all servers.

If registration is successful, this endpoint will issue an access token the client can use to authorize itself in subsequent requests.

If the client does not supply a device_id, the server must auto-generate one.

The server SHOULD register an account with a User ID based on the username provided, if any. Note that the grammar of Matrix User ID localparts is restricted, so the server MUST either map the provided username onto a user_id in a logical manner, or reject username\s which do not comply to the grammar, with M_INVALID_USERNAME.

Matrix clients MUST NOT assume that localpart of the registered user_id matches the provided username.

The returned access token must be associated with the device_id supplied by the client or generated by the server. The server may invalidate any access token previously associated with that device. See Relationship between access tokens and devices_.

register-with-http-info clj

(register-with-http-info)

(register-with-http-info {:keys [kind body]})

Register for an account on this homeserver. This API endpoint uses the User-Interactive Authentication API_.

Register for an account on this homeserver.

There are two kinds of user account:

• user accounts. These accounts may use the full API described in this specification.

• guest accounts. These accounts may have limited permissions and may not be supported by all servers.

If registration is successful, this endpoint will issue an access token the client can use to authorize itself in subsequent requests.

If the client does not supply a device_id, the server must auto-generate one.

The server SHOULD register an account with a User ID based on the username provided, if any. Note that the grammar of Matrix User ID localparts is restricted, so the server MUST either map the provided username onto a user_id in a logical manner, or reject username\s which do not comply to the grammar, with M_INVALID_USERNAME.

Matrix clients MUST NOT assume that localpart of the registered user_id matches the provided username.

The returned access token must be associated with the device_id supplied by the client or generated by the server. The server may invalidate any access token previously associated with that device. See Relationship between access tokens and devices_.

set-account-data clj

(set-account-data user-id type content)

Set some account_data for the user. Set some account_data for the client. This config is only visible to the user that set the account_data. The config will be synced to clients in the top-level account_data.

set-account-data-per-room clj

(set-account-data-per-room user-id room-id type content)

Set some account_data for the user. Set some account_data for the client on a given room. This config is only visible to the user that set the account_data. The config will be synced to clients in the per-room account_data.

set-account-data-per-room-with-http-info clj

(set-account-data-per-room-with-http-info user-id room-id type content)

Set some account_data for the user. Set some account_data for the client on a given room. This config is only visible to the user that set the account_data. The config will be synced to clients in the per-room account_data.

set-account-data-with-http-info clj

(set-account-data-with-http-info user-id type content)

Set some account_data for the user. Set some account_data for the client. This config is only visible to the user that set the account_data. The config will be synced to clients in the top-level account_data.

set-avatar-url clj

(set-avatar-url user-id avatar-url)

Set the user's avatar URL. This API sets the given user's avatar URL. You must have permission to set this user's avatar URL, e.g. you need to have their access_token.

set-avatar-url-with-http-info clj

(set-avatar-url-with-http-info user-id avatar-url)

Set the user's avatar URL. This API sets the given user's avatar URL. You must have permission to set this user's avatar URL, e.g. you need to have their access_token.

set-display-name clj

(set-display-name user-id display-name)

Set the user's display name. This API sets the given user's display name. You must have permission to set this user's display name, e.g. you need to have their access_token.

set-display-name-with-http-info clj

(set-display-name-with-http-info user-id display-name)

Set the user's display name. This API sets the given user's display name. You must have permission to set this user's display name, e.g. you need to have their access_token.

set-room-tag clj

(set-room-tag user-id room-id tag body)

Add a tag to a room. Add a tag to the room.

set-room-tag-with-http-info clj

(set-room-tag-with-http-info user-id room-id tag body)

Add a tag to a room. Add a tag to the room.