Type Alias Qr

Type declaration

• { kind: "askVerifyContact" } & {
      authcode: string;
      contact_id: T.U32;
      fingerprint: string;
      invitenumber: string;
  }

  • kind: "askVerifyContact"

    Ask the user whether to verify the contact.

    If the user agrees, pass this QR code to [crate::securejoin::join_securejoin].

  • authcode: string

    Authentication code.

  • contact_id: T.U32

    ID of the contact.

  • fingerprint: string

    Fingerprint of the contact key as scanned from the QR code.

  • invitenumber: string

    Invite number.
• { kind: "askVerifyGroup" } & {
      authcode: string;
      contact_id: T.U32;
      fingerprint: string;
      grpid: string;
      grpname: string;
      invitenumber: string;
  }

  • kind: "askVerifyGroup"

    Ask the user whether to join the group.

  • authcode: string

    Authentication code.

  • contact_id: T.U32

    ID of the contact.

  • fingerprint: string

    Fingerprint of the contact key as scanned from the QR code.

  • grpid: string

    Group ID.

  • grpname: string

    Group name.

  • invitenumber: string

    Invite number.
• { kind: "fprOk" } & { contact_id: T.U32 }

  • kind: "fprOk"

    Contact fingerprint is verified.

    Ask the user if they want to start chatting.

  • contact_id: T.U32

    Contact ID.
• { kind: "fprMismatch" } & { contact_id: T.U32 | null }

  • kind: "fprMismatch"

    Scanned fingerprint does not match the last seen fingerprint.

  • contact_id: T.U32 | null

    Contact ID.
• { kind: "fprWithoutAddr" } & { fingerprint: string }

  • kind: "fprWithoutAddr"

    The scanned QR code contains a fingerprint but no e-mail address.

  • fingerprint: string

    Key fingerprint.
• { kind: "account" } & { domain: string }

  • kind: "account"

    Ask the user if they want to create an account on the given domain.

  • domain: string

    Server domain name.
• { kind: "backup2" } & { auth_token: string; node_addr: string }

  • kind: "backup2"

    Provides a backup that can be retrieved using iroh-net based backup transfer protocol.

  • auth_token: string

    Authentication token.

  • node_addr: string

    Iroh node address.
• { kind: "backupTooNew" } & {}
• { kind: "webrtcInstance" } & { domain: string; instance_pattern: string }

  • kind: "webrtcInstance"

    Ask the user if they want to use the given service for video chats.

  • domain: string

  • instance_pattern: string

• { kind: "proxy" } & { host: string; port: U16; url: string }

  • kind: "proxy"

    Ask the user if they want to use the given proxy.

    Note that HTTP(S) URLs without a path and query parameters are treated as HTTP(S) proxy URL. UI may want to still offer to open the URL in the browser if QR code contents starts with http:// or https:// and the QR code was not scanned from the proxy configuration screen.

  • host: string

    Host extracted from the URL to display in the UI.

  • port: U16

    Port extracted from the URL to display in the UI.

  • url: string

    Proxy URL.

    This is the URL that is going to be added.
• { kind: "addr" } & { contact_id: T.U32; draft: string | null }

  • kind: "addr"

    Contact address is scanned.

    Optionally, a draft message could be provided. Ask the user if they want to start chatting.

  • contact_id: T.U32

    Contact ID.

  • draft: string | null

    Draft message.
• { kind: "url" } & { url: string }

  • kind: "url"

    URL scanned.

    Ask the user if they want to open a browser or copy the URL to clipboard.

  • url: string

• { kind: "text" } & { text: string }

  • kind: "text"

    Text scanned.

    Ask the user if they want to copy the text to clipboard.

  • text: string

• { kind: "withdrawVerifyContact" } & {
      authcode: string;
      contact_id: T.U32;
      fingerprint: string;
      invitenumber: string;
  }

  • kind: "withdrawVerifyContact"

    Ask the user if they want to withdraw their own QR code.

  • authcode: string

    Authentication code.

  • contact_id: T.U32

    Contact ID.

  • fingerprint: string

    Fingerprint of the contact key as scanned from the QR code.

  • invitenumber: string

    Invite number.
• { kind: "withdrawVerifyGroup" } & {
      authcode: string;
      contact_id: T.U32;
      fingerprint: string;
      grpid: string;
      grpname: string;
      invitenumber: string;
  }

  • kind: "withdrawVerifyGroup"

    Ask the user if they want to withdraw their own group invite QR code.

  • authcode: string

    Authentication code.

  • contact_id: T.U32

    Contact ID.

  • fingerprint: string

    Fingerprint of the contact key as scanned from the QR code.

  • grpid: string

    Group ID.

  • grpname: string

    Group name.

  • invitenumber: string

    Invite number.
• { kind: "reviveVerifyContact" } & {
      authcode: string;
      contact_id: T.U32;
      fingerprint: string;
      invitenumber: string;
  }

  • kind: "reviveVerifyContact"

    Ask the user if they want to revive their own QR code.

  • authcode: string

    Authentication code.

  • contact_id: T.U32

    Contact ID.

  • fingerprint: string

    Fingerprint of the contact key as scanned from the QR code.

  • invitenumber: string

    Invite number.
• { kind: "reviveVerifyGroup" } & {
      authcode: string;
      contact_id: T.U32;
      fingerprint: string;
      grpid: string;
      grpname: string;
      invitenumber: string;
  }

  • kind: "reviveVerifyGroup"

    Ask the user if they want to revive their own group invite QR code.

  • authcode: string

    Authentication code.

  • contact_id: T.U32

    Contact ID.

  • fingerprint: string

    Fingerprint of the contact key as scanned from the QR code.

  • grpid: string

    Group ID.

  • grpname: string

    Contact ID.

  • invitenumber: string

    Invite number.
• { kind: "login" } & { address: string }

  • kind: "login"

    dclogin: scheme parameters.

    Ask the user if they want to login with the email address.

  • address: string