Variable retiringState

Type Declaration

• • (
        realmOrId: any,
    ): {
        finish: string;
        finishesBy: number;
        inProgress: boolean;
        interrupted: boolean;
        refusing: string;
        since: number;
        sinceIso: string;
        why: string;
    }

  • Describes a realm being removed, for a console page and the API.

    Parameters

    • realmOrId: any

      a realm record or id; the ambient realm when omitted

    Returns {
        finish: string;
        finishesBy: number;
        inProgress: boolean;
        interrupted: boolean;
        refusing: string;
        since: number;
        sinceIso: string;
        why: string;
    }

    null when it is not being removed, else { since, sinceIso, inProgress, interrupted, finishesBy, refusing, why, finish }