Class App<FunctionsFactoryType, CustomDataType>

The class represents an Atlas App Services Application.

const app = new App({ id: "my-app-qwert" });

Type Parameters

FunctionsFactoryType extends DefaultFunctionsFactory = DefaultFunctionsFactory
CustomDataType extends DefaultObject = DefaultObject

Index

Constructors

constructor

new App<FunctionsFactoryType, CustomDataType>(id): export=.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 export=.App<FunctionsFactoryType, CustomDataType>
Throws
an Error If no id is provided.
- Defined in packages/realm/src/app-services/App.ts:250
new App<FunctionsFactoryType, CustomDataType>(config): export=.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 export=.App<FunctionsFactoryType, CustomDataType>
Throws
an Error If no app id is provided.
- Defined in packages/realm/src/app-services/App.ts:257

Accessors

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.
- Defined in packages/realm/src/app-services/App.ts:343

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.
- Defined in packages/realm/src/app-services/App.ts:334

emailPasswordAuth

get emailPasswordAuth(): EmailPasswordAuth
Perform operations related to the email/password auth provider.

Returns EmailPasswordAuth
An instance of the email password authentication provider.
- Defined in packages/realm/src/app-services/App.ts:324

id

get id(): string
Returns string
The app ID.
- Defined in packages/realm/src/app-services/App.ts:305

Methods

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
- Defined in packages/realm/src/app-services/App.ts:378

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.
- Defined in packages/realm/src/app-services/App.ts:369

logIn

logIn(credentials): Promise<User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>>
Log in a user.
Parameters
- credentials: export=.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.
- Defined in packages/realm/src/app-services/App.ts:315

removeAllListeners

removeAllListeners(): void
Removes all event listeners previously added via App.addListener.

Returns void
- Defined in packages/realm/src/app-services/App.ts:393

removeListener

removeListener(callback): void
Removes an event listener previously added via App.addListener.
Parameters
- callback: AppChangeCallback
  The callback to remove.
Returns void
- Defined in packages/realm/src/app-services/App.ts:386

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.
- Defined in packages/realm/src/app-services/App.ts:360

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.
- Defined in packages/realm/src/app-services/App.ts:352

`Static` get

get(id): export=.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 export=.App<DefaultFunctionsFactory, DefaultObject>
The Realm App instance.
- Defined in packages/realm/src/app-services/App.ts:204

`Static` getApp

getApp(id): export=.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 export=.App<DefaultFunctionsFactory, DefaultObject>
The Realm App instance.

Deprecated
Use App.get.
- Defined in packages/realm/src/app-services/App.ts:194

Class App<FunctionsFactoryType, CustomDataType>

Type Parameters

FunctionsFactoryType extends DefaultFunctionsFactory = DefaultFunctionsFactory

CustomDataType extends DefaultObject = DefaultObject

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

FunctionsFactoryType extends DefaultFunctionsFactory = DefaultFunctionsFactory

CustomDataType extends DefaultObject = DefaultObject

Parameters

id: string

Returns export=.App<FunctionsFactoryType, CustomDataType>

Throws

Type Parameters

FunctionsFactoryType extends DefaultFunctionsFactory = DefaultFunctionsFactory

CustomDataType extends DefaultObject = DefaultObject

Parameters

config: AppConfiguration

Returns export=.App<FunctionsFactoryType, CustomDataType>

Throws

Accessors

allUsers

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

currentUser

Returns null | User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>

emailPasswordAuth

Returns EmailPasswordAuth

id

Returns string

Methods

addListener

Parameters

callback: AppChangeCallback

Returns void

deleteUser

Parameters

user: AnyUser

Returns Promise<void>

logIn

Parameters

credentials: export=.Credentials

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

Throws

removeAllListeners

Returns void

removeListener

Parameters

callback: AppChangeCallback

Returns void

removeUser

Parameters

user: AnyUser

Returns Promise<void>

switchUser

Parameters

user: AnyUser

Returns void

Throws

Static get

Parameters

id: string

Returns export=.App<DefaultFunctionsFactory, DefaultObject>

Static getApp

Parameters

id: string

Returns export=.App<DefaultFunctionsFactory, DefaultObject>

Deprecated

Settings

Member Visibility

Theme

On This Page

`Static` get

`Static` getApp