com.mongodb.stitch.core

Class StitchAppClientInfo

java.lang.Object

com.mongodb.stitch.core.StitchAppClientInfo

public final class StitchAppClientInfo
extends Object

A class providing basic information about a Stitch app client.

Constructor Summary

Constructors

Constructor and Description
StitchAppClientInfo(String clientAppId, String dataDirectory, String localAppName, String localAppVersion, CodecRegistry codecRegistry, NetworkMonitor networkMonitor, AuthMonitor authMonitor, Dispatcher eventDispatcher) Constructs the StitchAppClientInfo.

Method Summary

Modifier and Type	Method and Description
AuthMonitor	getAuthMonitor() Gets the AuthMonitor that the client will used to check auth status.
String	getClientAppId() Gets the client app id of the Stitch application that this client communicates with.
CodecRegistry	getCodecRegistry() Returns the codec registry.
String	getDataDirectory() Gets the local directory in which Stitch can store any data (e.g.
Dispatcher	getEventDispatcher() Gets the Dispatcher that the client will use to send events on.
String	getLocalAppName() Gets the name of the local application.
String	getLocalAppVersion() Gets the current version of the local application.
NetworkMonitor	getNetworkMonitor() Gets the NetworkMonitor that the client will used to check internet status.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StitchAppClientInfo

public StitchAppClientInfo(String clientAppId,
                           String dataDirectory,
                           String localAppName,
                           String localAppVersion,
                           CodecRegistry codecRegistry,
                           NetworkMonitor networkMonitor,
                           AuthMonitor authMonitor,
                           Dispatcher eventDispatcher)

Constructs the StitchAppClientInfo.

Parameters:

clientAppId - the client app id of the Stitch application that this client is going to communicate with.

dataDirectory - the local directory in which Stitch can store any data (e.g. embedded MongoDB data directory).

localAppName - the name of the local application.

localAppVersion - the current version of the local application.

codecRegistry - the codec registry being used for encoding/decoding of JSON.

networkMonitor - the network monitor that the client will used to check internet status.

authMonitor - the auth monitor that the client will used to check auth status.

eventDispatcher - the dispatcher that the client will used to send events on.

Method Detail

getClientAppId

public String getClientAppId()

Gets the client app id of the Stitch application that this client communicates with.

Returns:

the client app id of the Stitch application that this client communicates with.

getDataDirectory

public String getDataDirectory()

Gets the local directory in which Stitch can store any data (e.g. MongoDB Mobile data directory).

Returns:

the local directory in which Stitch can store any data.

getLocalAppName

public String getLocalAppName()

Gets the name of the local application.

Returns:

the name of the local application..

getLocalAppVersion

public String getLocalAppVersion()

Gets the current version of the local application.

Returns:

the current version of the local application..

getCodecRegistry

public CodecRegistry getCodecRegistry()

Returns the codec registry.

Returns:

the codec registry.

getNetworkMonitor

public NetworkMonitor getNetworkMonitor()

Gets the NetworkMonitor that the client will used to check internet status.

Returns:

the NetworkMonitor that the client will used to check internet status.

getAuthMonitor

public AuthMonitor getAuthMonitor()

Gets the AuthMonitor that the client will used to check auth status.

Returns:

the AuthMonitor that the client will used to check auth status.

getEventDispatcher

public Dispatcher getEventDispatcher()

Gets the Dispatcher that the client will use to send events on.

Returns:

the Dispatcher that the client will use to send events on.