noordstar / elm-matrix-sdk-beta / Matrix.Settings

The Matrix Vault has lots of configurable variables that you rarely want to interact with. Usually, you configure these variables only when creating a new Vault, or when a user explicitly changes one of their preferred settings.

Device name

The default device name that is being communicated with the Matrix API.

This is mostly useful for users who are logged in with multiple sessions. They will see device names like "Element for Android" or "Element on iOS". For the Elm SDK, they will by default see the Elm SDK with its version included. If you are writing a custom client, however, you are free to change this to something more meaningful to the user.

getDeviceName : Types.Vault -> String

Determine the device name.

setDeviceName : String -> Types.Vault -> Types.Vault

Override the device name.

Sync time

Whenever the Matrix API has nothing new to report, the Elm SDK is kept on hold until something new happens. The syncTime indicates a timeout to how long the Elm SDK tolerates being held on hold.

Nowadays, most libraries use 30 seconds as the standard, as does the Elm SDK. The value is in miliseconds, so it is set at 30,000.

getSyncTime : Types.Vault -> Basics.Int

Determine the sync timeout value.

setSyncTime : Basics.Int -> Types.Vault -> Types.Vault

Override the sync timeout value.