docs: SecurejoinInviterProgress never returns an error

This commit is contained in:
link2xt
2025-09-23 14:33:35 +00:00
committed by l
parent 42b4b83f8e
commit 4c66518a68
4 changed files with 11 additions and 28 deletions

View File

@@ -294,8 +294,8 @@ pub enum EventType {
#[serde(rename_all = "camelCase")]
ImexFileWritten { path: String },
/// Progress information of a secure-join handshake from the view of the inviter
/// (Alice, the person who shows the QR code).
/// Progress event sent when SecureJoin protocol has finished
/// from the view of the inviter (Alice, the person who shows the QR code).
///
/// These events are typically sent after a joiner has scanned the QR code
/// generated by getChatSecurejoinQrCodeSvg().
@@ -309,9 +309,7 @@ pub enum EventType {
/// as `BasicChat.chatType` ([`crate::api::types::chat::BasicChat::chat_type`]).
chat_type: u32,
/// Progress as:
/// 0=Error.
/// 1000=Protocol finished for this contact.
/// Progress, always 1000.
progress: usize,
},