Update comment on olm_account_one_time_keys
Document what it actually returns.
This commit is contained in:
parent
ec7d968623
commit
76aad9d9c3
1 changed files with 15 additions and 1 deletions
|
@ -205,7 +205,21 @@ size_t olm_account_one_time_keys_length(
|
||||||
);
|
);
|
||||||
|
|
||||||
/** Writes the public parts of the unpublished one time keys for the account
|
/** Writes the public parts of the unpublished one time keys for the account
|
||||||
* into the one_time_keys output buffer. Returns olm_error() on failure.
|
* into the one_time_keys output buffer.
|
||||||
|
* <p>
|
||||||
|
* The returned data is a JSON-formatted object with the single property
|
||||||
|
* <tt>curve25519</tt>, which is itself an object mapping key id to
|
||||||
|
* base64-encoded Curve25519 key. For example:
|
||||||
|
* <pre>
|
||||||
|
* {
|
||||||
|
* curve25519: {
|
||||||
|
* "AAAAAA": "wo76WcYtb0Vk/pBOdmduiGJ0wIEjW4IBMbbQn7aSnTo",
|
||||||
|
* "AAAAAB": "LRvjo46L1X2vx69sS9QNFD29HWulxrmW11Up5AfAjgU"
|
||||||
|
* }
|
||||||
|
* }
|
||||||
|
* </pre>
|
||||||
|
* Returns olm_error() on failure.
|
||||||
|
* <p>
|
||||||
* If the one_time_keys buffer was too small then olm_account_last_error()
|
* If the one_time_keys buffer was too small then olm_account_last_error()
|
||||||
* will be "OUTPUT_BUFFER_TOO_SMALL". */
|
* will be "OUTPUT_BUFFER_TOO_SMALL". */
|
||||||
size_t olm_account_one_time_keys(
|
size_t olm_account_one_time_keys(
|
||||||
|
|
Loading…
Reference in a new issue