Class App<FunctionsFactoryType, CustomDataType>

constructor

• new App<FunctionsFactoryType, CustomDataType>(id): App<FunctionsFactoryType, CustomDataType>

• Constructs a new App instance, used to connect to an Atlas App Services App.

  Type Parameters

  • FunctionsFactoryType extends DefaultFunctionsFactory = DefaultFunctionsFactory

  • CustomDataType extends DefaultObject = DefaultObject

  Parameters

  • id: string

    A string app ID.

  Returns App<FunctionsFactoryType, CustomDataType>

  Throws

  an Error If no id is provided.

• new App<FunctionsFactoryType, CustomDataType>(config): App<FunctionsFactoryType, CustomDataType>

• Constructs a new App instance, used to connect to an Atlas App Services App.

  Type Parameters

  • FunctionsFactoryType extends DefaultFunctionsFactory = DefaultFunctionsFactory

  • CustomDataType extends DefaultObject = DefaultObject

  Parameters

  • config: AppConfiguration

    The configuration of the app.

  Returns App<FunctionsFactoryType, CustomDataType>

  Throws

  an Error If no app id is provided.

Static Credentials

Static Sync

allUsers

• get allUsers(): Readonly<Record<string, User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>>>

• All users that have logged into the device and have not been removed.

  Returns Readonly<Record<string, User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>>>

  A mapping from user ID to user.

currentUser

• get currentUser(): null | User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>

• The last user to log in or being switched to.

  Returns null | User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>

  A User object representing the currently logged in user. If no user is logged in, null is returned.

emailPasswordAuth

• get emailPasswordAuth(): EmailPasswordAuth

• Perform operations related to the email/password auth provider.

  Returns EmailPasswordAuth

  An instance of the email password authentication provider.

id

• get id(): string

• Returns string

  The app ID.

addListener

• addListener(callback): void

• Adds a listener that will be fired on various user events. This includes login, logout, switching users, linking users and refreshing custom data.

  Parameters

  • callback: AppChangeCallback

    A callback function that will be called when the event occurs.

  Returns void

deleteUser

• deleteUser(user): Promise<void>

• Delete the user. NOTE: This irrecoverably deletes the user from the device as well as the server!

  Parameters

  • user: AnyUser

  Returns Promise<void>

  A promise that resolves once the user has been deleted.

logIn

• logIn(credentials): Promise<User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>>

• Log in a user.

  Parameters

  • credentials: Credentials

    A credentials object describing the type of authentication provider and its parameters.

  Returns Promise<User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>>

  A promise that resolves to the logged in User.

  Throws

  An Error if the login failed.

removeAllListeners

• removeAllListeners(): void

• Removes all event listeners previously added via App.addListener.

  Returns void

removeListener

• removeListener(callback): void

• Removes an event listener previously added via App.addListener.

  Parameters

  • callback: AppChangeCallback

    The callback to remove.

  Returns void

removeUser

• removeUser(user): Promise<void>

• Logs out and removes a user from the client.

  Parameters

  • user: AnyUser

  Returns Promise<void>

  A promise that resolves once the user has been logged out and removed from the app.

switchUser

• switchUser(user): void

• Switches the current user to the one specified in user.

  Parameters

  • user: AnyUser

    The user to switch to.

  Returns void

  Throws

  an Error if the new user is logged out or removed.

Static get

• get(id): App<DefaultFunctionsFactory, DefaultObject>

• Get or create a singleton Realm App from an ID. Calling this function multiple times with the same ID will return the same instance.

  Parameters

  • id: string

    The Realm App ID visible from the Atlas App Services UI or a configuration.

  Returns App<DefaultFunctionsFactory, DefaultObject>

  The Realm App instance.

Static getApp

• getApp(id): App<DefaultFunctionsFactory, DefaultObject>

• Get or create a singleton Realm App from an ID. Calling this function multiple times with the same ID will return the same instance.

  Parameters

  • id: string

    The Realm App ID visible from the Atlas App Services UI or a configuration.

  Returns App<DefaultFunctionsFactory, DefaultObject>

  The Realm App instance.

  Deprecated

  Use App.get.