Type alias Realm

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

  • createRealm(realmName: string, realmData?: RealmSkeleton): Promise<RealmSkeleton>

  • Create realm

    Parameters

    • realmName: string

      realm name
    • Optional realmData: RealmSkeleton

      realm data

    Returns Promise<RealmSkeleton>

    a promise resolving to a realm object

• deleteRealm:function

  • deleteRealm(realmId: string): Promise<RealmSkeleton>

  • Delete realm

    Parameters

    • realmId: string

      realm id

    Returns Promise<RealmSkeleton>

    a promise resolving to a realm object

• deleteRealmByName:function

  • deleteRealmByName(realmName: string): Promise<RealmSkeleton>

  • Delete realm by name

    Parameters

    • realmName: string

      realm name

    Returns Promise<RealmSkeleton>

    a promise resolving to a realm object

• 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>
    Copy

• getRealms:function

  • getRealms(): Promise<RealmSkeleton[]>

  • Get all realms

    Returns Promise<RealmSkeleton[]>

    a promise resolving to an array of realm objects

    Deprecated

    since v2.0.0 use readRealms instead

    readRealms(): Promise<RealmSkeleton[]>
    Copy

• putRealm:function

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

  • Update realm

    Parameters

    • realmId: string

      realm id
    • realmData: RealmSkeleton

      realm data

    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>
    Copy

• readRealm:function

  • readRealm(realmId: string): Promise<RealmSkeleton>

  • Read realm

    Parameters

    • realmId: string

      realm id

    Returns Promise<RealmSkeleton>

    a promise resolving to a realm object

• readRealmByName:function

  • readRealmByName(realmName: string): Promise<RealmSkeleton>

  • Read realm by name

    Parameters

    • realmName: string

      realm name

    Returns Promise<RealmSkeleton>

    a promise resolving to a realm object

• readRealms:function

  • readRealms(): Promise<RealmSkeleton[]>

  • Read all realms

    Returns Promise<RealmSkeleton[]>

    a promise resolving to an array of realm objects

• 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

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

  • Update realm

    Parameters

    • realmId: string

      realm id
    • realmData: RealmSkeleton

      realm data

    Returns Promise<RealmSkeleton>

    a promise resolving to a realm object