Class ClientDataUpdaterFactory

Inheritance
object
ClientDataUpdaterFactory
Implements
Inherited Members
Namespace: LemonEdge.Client.DB
Assembly: LemonEdge.ClientDB.dll
Syntax
public class ClientDataUpdaterFactory : IDataUpdaterFactory, IUpdateServiceConnection, IClientConnectionType

Constructors

ClientDataUpdaterFactory(IFactoryInjector, IOptions<ConnectionSettings>, ICacheManager)

Declaration
public ClientDataUpdaterFactory(IFactoryInjector factory, IOptions<ConnectionSettings> connectionSettings, ICacheManager cacheManager = null)
Parameters
Type Name Description
IFactoryInjector factory
IOptions<ConnectionSettings> connectionSettings
ICacheManager cacheManager

Properties

CurrentServiceConnection

The current connection settings

Declaration
public string CurrentServiceConnection { get; }
Property Value
Type Description
string

LoggedInUserFriendlyConnection

The user friendly part of the connection string specific to this provider type

Declaration
public string LoggedInUserFriendlyConnection { get; set; }
Property Value
Type Description
string

Type

The type of connection this provider is supporting

Declaration
public ConnectionType Type { get; }
Property Value
Type Description
ConnectionType

Methods

Create(IConnector)

Creates a new instance of the IEntityUpdaterUI core interface for retrieving, querying and updating all data in the system

Declaration
public Task<IEntityUpdaterUI> Create(IConnector connector)
Parameters
Type Name Description
IConnector connector

The connector, which should contain the current user.
Returns
Type Description
Task<IEntityUpdaterUI>

A new instance of the IEntityUpdaterUI core interface for retrieving, querying and updating all data in the system

CreateAuthenticator(IConnector)

Returns an implementation of the IAuthenticator to provide login services.

You do not need to use this directly, you can instead login from Connector.Login(string,string)

Declaration
public IAuthenticator CreateAuthenticator(IConnector connector)
Parameters
Type Name Description
IConnector connector

The current connector requesting the interface
Returns
Type Description
IAuthenticator

An implementation of the IAuthenticator to provide login services.

CreateDatabaseStatusProxy(IConnector)

Returns an implementation of the IDatabaseStatusProxy to provide database status.

Declaration
public IDatabaseStatusProxy CreateDatabaseStatusProxy(IConnector connector)
Parameters
Type Name Description
IConnector connector

The current connector requesting the interface
Returns
Type Description
IDatabaseStatusProxy

An implementation of the IDatabaseStatusProxy to provide database status.

CreateDynamicEntityLoader(IConnector)

Returns an implementation of the IDynamicEntityLoader to provide login services.

Declaration
public IDynamicEntityLoader CreateDynamicEntityLoader(IConnector connector)
Parameters
Type Name Description
IConnector connector

The current connector requesting the interface
Returns
Type Description
IDynamicEntityLoader

An implementation of the IDynamicEntityLoader to provide login services.

CreateStorageManager()

Creates a new instance of the IStorageManager

Declaration
public IStorageManager CreateStorageManager()
Returns
Type Description
IStorageManager

ReloadCache()

Reloads the cache for the current connector

Declaration
public Task ReloadCache()
Returns
Type Description
Task

UpdateServiceConnection(string, bool)

Indicates we should use the specified connection url for connecting to a web service

This takes time to complete as the system verifies the webs service, and downloads the model of the webservice it is connecting to (as LemonEdge services can have different models depending on the addins)

Declaration
public Task UpdateServiceConnection(string connection, bool force = false)
Parameters
Type Name Description
string connection

A valid url connection to a LemonEdge web service
bool force

Whether to force a refresh of an existing connection.
Returns
Type Description
Task

A task indicating the completion of the operation

Implements

Extension Methods