Skip to main content
Version: 0.9.0 (next)

RequestOnboardingCodesOptions class

A request for a new set of one-time onboarding codes. Every request gets codes of its own; codes other callers hold and the hub's onboarding screen code stay valid.

Namespace: Quaternar.Qaros · Assembly: Quaternar.Qaros.dll

public sealed class RequestOnboardingCodesOptions

Properties​

MemberDescription
CountHow many codes, 1 to 64.
LifetimeHow long each code stays valid; zero takes the hub default (120 s). At most 600 s.
PlannedPeerIdWhen set, a device pairing with one of these codes can only join under this peer id.

Count​

How many codes, 1 to 64.

public uint Count { get; set; }

Value: uint

Lifetime​

How long each code stays valid; zero takes the hub default (120 s). At most 600 s.

public TimeSpan Lifetime { get; set; }

Value: TimeSpan

PlannedPeerId​

When set, a device pairing with one of these codes can only join under this peer id.

public PeerId? PlannedPeerId { get; set; }

Value: PeerId?