Mirrors/chatmail-core
1
0
Fork 0
mirror of https://github.com/chatmail/core.git synced 2026-05-09 01:46:30 +03:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs

Browse Source
This commit is contained in:
Hocuri
2025-09-11 17:53:41 +02:00
parent e8fff886a0
commit cc54c68b29
2 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
deltachat-jsonrpc/src/api/types/qr.rs
View File

@@ -38,11 +38,15 @@ pub enum QrObject {
AskJoinBroadcast { AskJoinBroadcast {
/// Chat name. /// Chat name.
broadcast_name: String, broadcast_name: String,
/// Group ID. /// A string of random characters,
/// uniquely identifying this broadcast channel in the database.
/// Called `grpid` for historic reasons:
/// The id of multi-user chats is always called `grpid` in the database
/// because groups were once the only multi-user chats.
grpid: String, grpid: String,
/// ID of the contact. /// ID of the contact who owns the channel and created the QR code.
contact_id: u32, contact_id: u32,
/// Fingerprint of the contact key as scanned from the QR code. /// Fingerprint of the contact's key as scanned from the QR code.
fingerprint: String, fingerprint: String,
authcode: String, authcode: String,

4
src/qr.rs
View File

@@ -96,10 +96,10 @@ pub enum Qr {
/// because groups were once the only multi-user chats. /// because groups were once the only multi-user chats.
grpid: String, grpid: String,
/// The contact id of the inviter /// ID of the contact who owns the channel and created the QR code.
contact_id: ContactId, contact_id: ContactId,
/// The PGP fingerprint of the inviter /// Fingerprint of the contact's key as scanned from the QR code.
fingerprint: Fingerprint, fingerprint: Fingerprint,
/// The AUTH code from the secure-join protocol, /// The AUTH code from the secure-join protocol,