realm name
domain name
a promise resolving to a realm object
Create realm
realm name
OptionalrealmData: RealmSkeleton
realm data
a promise resolving to a realm object
Delete realm
realm id
a promise resolving to a realm object
Delete realm by name
realm name
a promise resolving to a realm object
Export all realms. The response can be saved to file as is.
Promise resolving to a RealmExportInterface object.
Import realms. Every realm is tried: a realm that cannot be imported does not stop the others.
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.
OptionalresultCallback: ResultCallback<RealmSkeleton>
Optional callback to process individual results. When given, the outcome of every realm is passed to it as it happens (a failed realm as an error that names it, with the cause nested) and a failed realm does not throw: the realms that could be imported are returned. Without it, the failures are collected and thrown as one error after every realm was tried.
the imported realms
Read realm
realm id
a promise resolving to a realm object
Read realm by name
realm name
a promise resolving to a realm object
Remove custom DNS domain name (realm DNS alias)
realm name
domain name
a promise resolving to a realm object
Update realm
realm id
realm data
a promise resolving to a realm object
Add custom DNS domain name (realm DNS alias)