The Vault type stores all relevant information about the Matrix API.

If you make sure that the data type stays up-to-date, you can use it to explore the latest information about an account.

Use a fully-fledged Matrix ID to connect.

case Matrix.fromUserId "@alice:example.org" of
    Just vault ->
        "We got a vault!"


    Nothing ->
        "Invalid username"

Using a username and an address, create a Vault.

The username can either be the localpart or the full Matrix ID. For example, you can either insert alice or @alice:example.org.

The VaultUpdate type is the central type that keeps the Vault up-to-date.

Using new VaultUpdate information, update the Vault accordingly.

This allows us to change our perception of the Matrix environment: has anyone sent a new message? Did someone send us an invite for a new room?

Synchronize the Vault with the Matrix API.

Effectively, this task asks the Matrix API to provide the latest information, which will be returned as your VaultUpdate.

The VaultUpdate is a complex type that helps update the Vault. However, it also contains a human output!

Using this function, you can get a human output that describes everything that the VaultUpdate has to tell the Vault.

The channel field describes the context of the log, allowing you to filter further. For example:

• debug is a comprehensive channel describing everything the Elm runtime has executed.
• warn contains warnings that aren't breaking, but relevant.
• securityWarn warns about potential security issues or potential attacks.
• error has errors that were encountered.
• caughtError has errors that were dealt with successfully.

Get a list of all the rooms that the user has joined.

Get a room based on its room ID, if the user is a member of that room.

Get a list of all invites that the user has received.

Get a specific invite to a given room Id.

Get global account data.

Set global account data.

Adds a custom access token to the Vault. This can be done if no password is provided or known.

Leave a room. This stops a user from participating in a room.

If the user was already in the room, they will no longer be able to see new events in the room. If the room requires an invite to join, they will need to be re-invited before they can re-join.

If the user was invited to the room, but had not joined, this call serves to reject the invite.

The user will still be allowed to retrieve history from the room which they were previously allowed to see.

Send a message event to a room.

This function can be used in a scenario where the user does not want to sync the client, or is unable to. This function doesn't check whether the given room exists and the user is able to send a message to, and instead just sends the request to the Matrix API.

The fields stand for the following:

• content is the JSON object that is sent to the Matrix room.
• eventType is the event type that is sent to the Matrix room.
• roomId is the Matrix room ID.
• toMsg is the msg type that is returned after the message has been sent.
• transactionId is a unique identifier that helps the Matrix server distringuish messages. If you send the same message with the same transactionId, the server promises to register it only once.
• vault is the Matrix Vault that contains all the latest and most relevant information.

Get personal information about the vault, such as the user id, the device id or other vital information.

When the vault logs in, it will automatically know this information. However, if you plug in an access token, the vault might not know. If you wish to ensure that such information is available, you can use this function to download that information.