Skip to content

Commit 86d035b

Browse files
committed
docs: add hint about how to reset an invitation
1 parent d069e75 commit 86d035b

2 files changed

Lines changed: 10 additions & 0 deletions

File tree

deltachat-ffi/deltachat.h

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2637,10 +2637,18 @@ dc_lot_t* dc_check_qr (dc_context_t* context, const char*
26372637
* DC_QR_ASK_VERIFYCONTACT, DC_QR_ASK_VERIFYGROUP or DC_QR_ASK_VERIFYBROADCAST
26382638
* an out-of-band-verification can be joined using dc_join_securejoin()
26392639
*
2640+
* If the device calling dc_check_qr() is the same device,
2641+
* #DC_QR_WITHDRAW_VERIFYCONTACT or #DC_QR_WITHDRAW_VERIFYGROUP will be returned instead,
2642+
* allowing to reset a QR code.
2643+
* By passing the resetted QR code again to dc_check_qr(), it finally can be revived.
2644+
* See dc_check_qr() for the detailed codes.
2645+
*
26402646
* The returned text will also work as a normal https:-link,
26412647
* so that the QR code is useful also without Delta Chat being installed
26422648
* or can be passed to contacts through other channels.
26432649
*
2650+
* To reset invitations, pass the link to dc_set_config_from_qr().
2651+
*
26442652
* @memberof dc_context_t
26452653
* @param context The context object.
26462654
* @param chat_id If set to a group-chat-id,

deltachat-jsonrpc/src/api.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -883,6 +883,8 @@ impl CommandApi {
883883

884884
/// Get QR code text that will offer a [SecureJoin](https://securejoin.delta.chat/) invitation.
885885
///
886+
/// To reset invitations, pass the link to `set_config_from_qr()``.
887+
///
886888
/// If `chat_id` is a group chat ID, SecureJoin QR code for the group is returned.
887889
/// If `chat_id` is unset, setup contact QR code is returned.
888890
async fn get_chat_securejoin_qr_code(

0 commit comments

Comments
 (0)