JSDoc: Class: WebcomApp

Class: WebcomApp

WebcomApp

Represents a Webcom application running one or more Webcom services with a given configuration. This is the root class to start developing apps using the Webcom SDK.

Currently, the available Webcom services are:

Authentication, which may be invoked by the WebcomApp#authentication property,
ServerlessDb, which may be invoked by the WebcomApp#serverlessDb property.

Instances of this class are built using the Webcom.App static method.

Since:

Members

(readonly) appId :string

The Webcom application identifier associated with this WebcomApp instance.

Type:

string

(readonly) authentication :Authentication

Accessor of the Authentication instance associated with this WebcomApp instance.

Type:

Authentication

Since:

(readonly) config :WebcomApp.Configuration

The WebcomApp.Configuration associated with this WebcomApp instance.

Type:

WebcomApp.Configuration

Since:

(readonly) serverlessDb :ServerlessDb

Accessor of the ServerlessDb instance associated with this WebcomApp instance.

Type:

ServerlessDb

Since:

(readonly) serverlessDbLite :ServerlessDbLite

Accessor of the ServerlessDbLite instance associated with this WebcomApp instance.

Type:

ServerlessDbLite

Since:

Methods

dispose()

Disposes all services attached to this WebcomApp instance, so that next access to any service will reinitialize it and create a new one.

Since:

Type Definitions

Configuration

Represents the configuration of all Webcom services to be instantiated from a WebcomApp instance. The base definition of this type is empty, however, each Webcom service adds a specific property. For example, the Authentication adds the Configuration#Authentication property.

Since:

Configuration

Properties:

Name	Type	Description
`Authentication`	Authentication.Configuration	Description of the configuration options for the `Authentication` to be associated with a given `WebcomApp` instance.

Since:

Configuration

Properties:

Name	Type	Description
`ServerlessDb`	ServerlessDb.Configuration	Description of the configuration options for the `ServerlessDb` to be associated with a given `WebcomApp` instance.

Since:

Configuration

Properties:

Name	Type	Description
`ServerlessDbLite`	ServerlessDbLite.Configuration	Description of the configuration options for the `ServerlessDbLite` to be associated with a given `WebcomApp` instance.