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>;
    importRealms(
        importData: RealmExportInterface,
        realmId?: string,
        realmName?: string,
    ): 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

Methods

addCustomDomain

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
- Defined in ops/RealmOps.ts:94

createRealm

createRealm(
realmName: string,
realmData?: RealmSkeleton,
): Promise<RealmSkeleton>
Create realm
Parameters
- realmName: string
  realm name
- OptionalrealmData: RealmSkeleton
  realm data
Returns Promise<RealmSkeleton>
a promise resolving to a realm object
- Defined in ops/RealmOps.ts:50

deleteRealm

deleteRealm(realmId: string): Promise<RealmSkeleton>
Delete realm
Parameters
- realmId: string
  realm id
Returns Promise<RealmSkeleton>
a promise resolving to a realm object
- Defined in ops/RealmOps.ts:81

deleteRealmByName

deleteRealmByName(realmName: string): Promise<RealmSkeleton>
Delete realm by name
Parameters
- realmName: string
  realm name
Returns Promise<RealmSkeleton>
a promise resolving to a realm object
- Defined in ops/RealmOps.ts:87

exportRealms

exportRealms(): Promise<RealmExportInterface>
Export all realms. The response can be saved to file as is.

Returns Promise<RealmExportInterface>
Promise resolving to a RealmExportInterface object.
- Defined in ops/RealmOps.ts:43

importRealms

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
- Defined in ops/RealmOps.ts:71

readRealm

readRealm(realmId: string): Promise<RealmSkeleton>
Read realm
Parameters
- realmId: string
  realm id
Returns Promise<RealmSkeleton>
a promise resolving to a realm object
- Defined in ops/RealmOps.ts:32

readRealmByName

readRealmByName(realmName: string): Promise<RealmSkeleton>
Read realm by name
Parameters
- realmName: string
  realm name
Returns Promise<RealmSkeleton>
a promise resolving to a realm object
- Defined in ops/RealmOps.ts:38

readRealms

readRealms(): Promise<RealmSkeleton[]>
Read all realms

Returns Promise<RealmSkeleton[]>
a promise resolving to an array of realm objects
- Defined in ops/RealmOps.ts:26

removeCustomDomain

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
- Defined in ops/RealmOps.ts:101

updateRealm

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
- Defined in ops/RealmOps.ts:60