Constructs a new App instance, used to connect to an Atlas App Services App.
A string app ID.
an Error If no id is provided.
Constructs a new App instance, used to connect to an Atlas App Services App.
The configuration of the app.
an Error If no app id is provided.
All users that have logged into the device and have not been removed.
A mapping from user ID to user.
Experimental Get the current base URL used for sending requests to Atlas App Services.
If an updateBaseUrl operation is currently in progress, this value will not be updated with the new value until that operation has completed. This feature is experimental and may be changed or removed.
The last user to log in or being switched to.
A User object representing the currently logged in user. If no user is logged in, null is returned.
Perform operations related to the email/password auth provider.
An instance of the email password authentication provider.
The app ID.
Adds a listener that will be fired on various user events. This includes login, logout, switching users, linking users and refreshing custom data.
A callback function that will be called when the event occurs.
Delete the user. NOTE: This irrecoverably deletes the user from the device as well as the server!
A promise that resolves once the user has been deleted.
Log in a user.
A credentials object describing the type of authentication provider and its parameters.
A promise that resolves to the logged in User.
An Error if the login failed.
Removes all event listeners previously added via App.addListener.
Removes an event listener previously added via App.addListener.
The callback to remove.
Logs out and removes a user from the client.
A promise that resolves once the user has been logged out and removed from the app.
Switches the current user to the one specified in user.
The user to switch to.
an Error if the new user is logged out or removed.
Experimental Update the base URL used for sending requests to Atlas App Services. If this is
set to an empty string or null, it will reset the base URL to the default one.
If this operation fails, the app will continue to use the original base URL. If another App operation is started while this function is in progress, that request will use the original base URL location information. This feature is experimental and may be changed or removed.
Static getGet or create a singleton Realm App from an ID. Calling this function multiple times with the same ID will return the same instance.
The Realm App ID visible from the Atlas App Services UI or a configuration.
The Realm App instance.
Static getGet or create a singleton Realm App from an ID. Calling this function multiple times with the same ID will return the same instance.
The Realm App ID visible from the Atlas App Services UI or a configuration.
The Realm App instance.
Use App.get.
Generated using TypeDoc
The class represents an Atlas App Services Application.