Class CloudStepHint

Namespace

Hi.Licenses

Assembly

HiDisp.dll

Internal Use Only. The account's step quota as the licence server last described it, kept in CloudStepHint by the cloud lease client (HiNc) for the machining runner (HiMech) to word a refused step from: the server's stepQuota block of a lease answer (the rolling week of a verified account, kind weekly, or the one-time trial of an unverified one, kind oneTime) with the answer's verified and the lease's tier. Immutable: a snapshot, since the client replaces the hint at every sync while the runner reads it. A plan without a quota – a paid plan, whose answer has no stepQuota – has QuotaKind null and every count 0.

public sealed class CloudStepHint

Inheritance

object

CloudStepHint

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])

InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)

InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)

ColorUtil.GetGloomyColor(object, double, double)

KindNameUtil.KindName(object)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Constructors

CloudStepHint(bool?, string, string, long, long, long, uint, long, DateTime?, uint, long)

Internal Use Only. Makes the hint.

public CloudStepHint(bool? verified, string tier, string quotaKind, long cap, long balance, long reserved, uint sessionCap, long refillNextSteps, DateTime? refillNextUtc, uint verifiedSessionCap, long verifiedWeekCap)

Parameters

verified bool?

Whether the account's email address is verified; null when the server did not say.

tier string

The plan tier of the lease (edu_trial, education, standard, professional ...); null when unknown.

quotaKind string

weekly or oneTime; null when the plan has no quota.

cap long

The budget of the quota: the steps per 7 days, or the one-time trial's steps.

balance long

What the account may still take beyond the installed lease's grant; floor 0.

reserved long

What the installed lease reserved: its sgrant claim.

sessionCap uint

The per-play step cap the lease signed; 0 = none.

refillNextSteps long

Weekly: the steps that drop out of the rolling week at the next UTC midnight; 0 for oneTime.

refillNextUtc DateTime?

Weekly: the next UTC midnight; null for oneTime.

verifiedSessionCap uint

oneTime: the per-play cap a verified account gets (0 = none); 0 for weekly.

verifiedWeekCap long

oneTime: the weekly budget a verified account gets; 0 for weekly.

Properties

Balance

What the account may still take beyond the installed lease's grant: the budget less what was used and forfeited, less the other devices' reservations, less Reserved; floor 0. 0 = the quota is used up once this lease's grant is.

public long Balance { get; }

Property Value

long

Cap

The budget: the steps over any 7 consecutive UTC days, or the one-time trial's steps.

public long Cap { get; }

Property Value

long

QuotaKind

weekly (a verified account's rolling 7 days) or oneTime (an unverified account's trial, which never refills); null when the plan has no quota.

public string QuotaKind { get; }

Property Value

string

RefillNextSteps

Weekly only: the steps that drop out of the rolling week at the next UTC midnight; 0 for oneTime.

public long RefillNextSteps { get; }

Property Value

long

RefillNextUtc

Weekly only: the next UTC midnight, when RefillNextSteps come back; null for oneTime.

public DateTime? RefillNextUtc { get; }

Property Value

DateTime?

Reserved

What the installed lease reserved (its sgrant claim): the smaller of the available steps and SessionCap.

public long Reserved { get; }

Property Value

long

SessionCap

The per-play step cap the lease signed (the licence's for a verified account, the unverified cap otherwise); 0 = none.

public uint SessionCap { get; }

Property Value

uint

Tier

The plan tier of the lease; null when unknown.

public string Tier { get; }

Property Value

string

Verified

Whether the account's email address is verified, which picks the weekly quota over the one-time trial; null when the server did not say.

public bool? Verified { get; }

Property Value

bool?

VerifiedSessionCap

oneTime only: the per-play cap a verified account gets (0 = none), for the wording that asks to verify; 0 for weekly.

public uint VerifiedSessionCap { get; }

Property Value

uint

VerifiedWeekCap

oneTime only: the weekly budget a verified account gets, for the wording that asks to verify; 0 for weekly.

public long VerifiedWeekCap { get; }

Property Value

long