Type Alias Realm

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>;
}

Type declaration

  • addCustomDomain:function
    • addCustomDomain(realmName: string, domain: string): Promise<RealmSkeleton>

      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

  • createRealm:function
  • deleteRealm:function
  • deleteRealmByName:function
  • exportRealms:function
  • getRealmByName:function
    • getRealmByName(realmName: string): Promise<RealmSkeleton>

      Get realm by name

      Parameters

      • realmName: string

        realm name

      Returns Promise<RealmSkeleton>

      a promise resolving to a realm object

      Deprecated

      since v2.0.0 use readRealmByName instead

      readRealmByName(realmName: string): Promise<RealmSkeleton>
  • getRealms:function
  • importRealms:function
    • importRealms(
          importData: RealmExportInterface,
          realmId?: string,
          realmName?: string,
      ): Promise<RealmSkeleton[]>

      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

  • putRealm:function
    • putRealm(realmId: string, realmData: RealmSkeleton): Promise<RealmSkeleton>

      Update realm

      Parameters

      Returns Promise<RealmSkeleton>

      a promise resolving to a realm object

      Deprecated

      since v2.0.0 use updateRealm or createRealm instead

      updateRealm(realmId: string, realmData: RealmSkeleton): Promise<RealmSkeleton>
      createRealm(realmName: string, realmData: RealmSkeleton): Promise<RealmSkeleton>
  • readRealm:function
  • readRealmByName:function
  • readRealms:function
  • removeCustomDomain:function
    • removeCustomDomain(realmName: string, domain: string): Promise<RealmSkeleton>

      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

  • updateRealm:function

Settings

Member Visibility