timoreo/olm
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Document olm_create_inbound_session_from properly.

Browse source 
The old docstring was the same as olm_create_inbound_session and didn't
explain the difference between them.
This commit is contained in:
Denis Kasak 2021-05-20 12:19:08 +02:00 committed by Hubert Chathi
parent 3e6592e445
commit 6ed8d687e8
1 changed files with 3 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
include/olm/olm.h
View file

@ -311,14 +311,9 @@ size_t olm_create_inbound_session(
void * one_time_key_message, size_t message_length void * one_time_key_message, size_t message_length
); );
/** Create a new in-bound session for sending/receiving messages from an /** Same as olm_create_inbound_session, but ensures that the identity key
* incoming PRE_KEY message. Returns olm_error() on failure. If the base64 * in the pre-key message matches the expected identity key, supplied via the
* couldn't be decoded then olm_session_last_error will be "INVALID_BASE64". * `their_identity_key` parameter. Fails early if there is no match. */
* If the message was for an unsupported protocol version then
* olm_session_last_error() will be "BAD_MESSAGE_VERSION". If the message
* couldn't be decoded then then olm_session_last_error() will be
* "BAD_MESSAGE_FORMAT". If the message refers to an unknown one time
* key then olm_session_last_error() will be "BAD_MESSAGE_KEY_ID". */
size_t olm_create_inbound_session_from( size_t olm_create_inbound_session_from(
OlmSession * session, OlmSession * session,
OlmAccount * account, OlmAccount * account,