Frodo Library - v4.0.0-10
    Preparing search index...

    Type Alias Realm

    type Realm = {
        addCustomDomain(
            realmName: string,
            domain: string,
        ): Promise<RealmSkeleton>;
        createRealm(
            realmName: string,
            realmData?: RealmSkeleton,
        ): Promise<RealmSkeleton>;
        deleteRealm(realmId: string): Promise<RealmSkeleton>;
        deleteRealmByName(realmName: string): Promise<RealmSkeleton>;
        exportRealms(): Promise<RealmExportInterface>;
        getRealmByName(realmName: string): Promise<RealmSkeleton>;
        getRealms(): Promise<RealmSkeleton[]>;
        importRealms(
            importData: RealmExportInterface,
            realmId?: string,
            realmName?: string,
        ): Promise<RealmSkeleton[]>;
        putRealm(realmId: string, realmData: RealmSkeleton): Promise<RealmSkeleton>;
        readRealm(realmId: string): Promise<RealmSkeleton>;
        readRealmByName(realmName: string): Promise<RealmSkeleton>;
        readRealms(): Promise<RealmSkeleton[]>;
        removeCustomDomain(
            realmName: string,
            domain: string,
        ): Promise<RealmSkeleton>;
        updateRealm(
            realmId: string,
            realmData: RealmSkeleton,
        ): Promise<RealmSkeleton>;
    }
    Index

    Methods

    addCustomDomain createRealm deleteRealm deleteRealmByName exportRealms importRealms readRealm readRealmByName readRealms removeCustomDomain updateRealm

    Deprecated

    getRealmByName getRealms putRealm

    Methods

    • Add custom DNS domain name (realm DNS alias)

      Parameters

      • realmName: string

        realm name

      • domain: string

        domain name

      Returns Promise<RealmSkeleton>

      a promise resolving to a realm object

    • Import realms

      Parameters

      • importData: RealmExportInterface

        realm import data

      • OptionalrealmId: string

        Optional realm id. If supplied, only the realm of that id is imported. Takes priority over realmName if both are provided.

      • OptionalrealmName: string

        Optional realm name. If supplied, only the realm of that name is imported.

      Returns Promise<RealmSkeleton[]>

      the imported realms

    • Remove custom DNS domain name (realm DNS alias)

      Parameters

      • realmName: string

        realm name

      • domain: string

        domain name

      Returns Promise<RealmSkeleton>

      a promise resolving to a realm object

    Deprecated

    • Get realm by name

      Parameters

      • realmName: string

        realm name

      Returns Promise<RealmSkeleton>

      a promise resolving to a realm object

      since v2.0.0 use readRealmByName instead

      readRealmByName(realmName: string): Promise<RealmSkeleton>

    • Update realm

      Parameters

      Returns Promise<RealmSkeleton>

      a promise resolving to a realm object

      since v2.0.0 use updateRealm or createRealm instead

      updateRealm(realmId: string, realmData: RealmSkeleton): Promise<RealmSkeleton>
      createRealm(realmName: string, realmData: RealmSkeleton): Promise<RealmSkeleton>

    Settings

    Member Visibility

    On This Page

    Methods
    Deprecated