Olm.Account (olm v0.1.0-rc) View Source

Functions for working with Olm Accounts.

Link to this section Summary

Functions

Creates a new account.

Generates a number of new one time keys.

Returns the public parts of the identity keys for the account.

Marks the current set of one time keys as being published.

The largest number of one time keys this account can store.

Returns the public parts of the unpublished one time keys for the account.

Stores an account as a base64 string. Encrypts the account using the supplied key.

Removes the one time keys that the session used from the account.

Signs a message with the ed25519 key for this account.

Loads an account from a pickled base64 string. Decrypts the account using the supplied key.

Link to this section Functions

Creates a new account.

Link to this function

generate_one_time_keys(account_ref, count, return \\ false)

View Source

Generates a number of new one time keys.

Link to this function

identity_keys(account_ref)

View Source

Returns the public parts of the identity keys for the account.

Link to this function

mark_keys_as_published(account_ref)

View Source

Marks the current set of one time keys as being published.

Link to this function

max_one_time_keys(account_ref)

View Source

The largest number of one time keys this account can store.

Link to this function

one_time_keys(account_ref)

View Source

Returns the public parts of the unpublished one time keys for the account.

Link to this function

pickle(account_ref, key)

View Source

Stores an account as a base64 string. Encrypts the account using the supplied key.

Link to this function

remove_one_time_keys(account_ref, session_ref)

View Source

Removes the one time keys that the session used from the account.

Link to this function

sign(account_ref, message)

View Source

Signs a message with the ed25519 key for this account.

Link to this function

unpickle(pickled_account, key)

View Source

Loads an account from a pickled base64 string. Decrypts the account using the supplied key.