Skip to main content
Version: 0.9.0 (next)

QarRequestOnboardingCodesInit Struct

Ask the hub for a new set of one-time onboarding codes. More...

Declaration​

struct QarRequestOnboardingCodesInit { ... }

Included Headers​

Public Member Attributes Index​

uint32_tcount

How many codes, 1 to 64. Also the length of the caller's out array. More...

QarStructureHeaderheader
uint32_tlifetime_seconds

Seconds each code stays valid; 0 -> 120. At most 600. More...

QarPeerIdplanned_peer_id

Description​

Ask the hub for a new set of one-time onboarding codes.

Every request mints codes of its own: codes other callers hold and the code on the hub's onboarding screen stay valid, and none of the new ones is announced or displayed. Each code works once and lapses after its lifetime.

Definition at line 1524 of file qar_streaming.h.

Public Member Attributes​

count​

uint32_t QarRequestOnboardingCodesInit::count

How many codes, 1 to 64. Also the length of the caller's out array.

Definition at line 1529 of file qar_streaming.h.

header​

QarStructureHeader QarRequestOnboardingCodesInit::header

QAR_STRUCTURE_TYPE_SESSION_REQUEST_ONBOARDING_CODES_INIT

Definition at line 1526 of file qar_streaming.h.

lifetime_seconds​

uint32_t QarRequestOnboardingCodesInit::lifetime_seconds

Seconds each code stays valid; 0 -> 120. At most 600.

Definition at line 1531 of file qar_streaming.h.

planned_peer_id​

QarPeerId QarRequestOnboardingCodesInit::planned_peer_id

Zero -> any device may use the codes. Otherwise a device pairing with one of them can only join under this peer id (QarOnboardPeerIdExt).

Definition at line 1534 of file qar_streaming.h.


The documentation for this struct was generated from the following file:


Generated via doxygen2docusaurus 2.2.1 by Doxygen 1.9.8.