Interface IRemoteConnection

An HTTP connection to an innovator instance (or proxy) that is not located in the same memory space as the current code

Inherited Members
System.IDisposable.Dispose()
Namespace: Innovator.Client
Assembly: Innovator.Client.dll
Syntax
public interface IRemoteConnection : IAsyncConnection, IConnection, IDisposable

Properties

| Improve this Doc View Source

Url

URL that the instance resides at

Declaration
Uri Url { get; }
Property Value
Type Description
System.Uri

Methods

| Improve this Doc View Source

Clone(Boolean)

Gets a new connection logged in with the same credentials

Declaration
IPromise<IRemoteConnection> Clone(bool async)
Parameters
Type Name Description
System.Boolean async

Whether to perform this action asynchronously
Returns
Type Description
IPromise<IRemoteConnection>

A promise to return a new connection
| Improve this Doc View Source

DefaultSettings(Action<IHttpRequest>)

Use a method to configure each outgoing HTTP request

Declaration
void DefaultSettings(Action<IHttpRequest> settings)
Parameters
Type Name Description
System.Action<IHttpRequest> settings

Action used to configure the request
| Improve this Doc View Source

GetDatabases()

Returns a set of databases which can be connected to using this URL

Declaration
IEnumerable<string> GetDatabases()
Returns
Type Description
System.Collections.Generic.IEnumerable<System.String>

A set of databases which can be connected to using this URL
| Improve this Doc View Source

Login(ICredentials)

Log in to the database

Declaration
void Login(ICredentials credentials)
Parameters
Type Name Description
ICredentials credentials

Credentials used for authenticating to the instance
| Improve this Doc View Source

Login(ICredentials, Boolean)

Log in to the database asynchronosuly

Declaration
IPromise<string> Login(ICredentials credentials, bool async)
Parameters
Type Name Description
ICredentials credentials

Credentials used for authenticating to the instance
System.Boolean async

Whether to perform this action asynchronously
Returns
Type Description
IPromise<System.String>

A promise to return the user ID as a string
| Improve this Doc View Source

Logout(Boolean)

Log out of the database

Declaration
void Logout(bool unlockOnLogout)
Parameters
Type Name Description
System.Boolean unlockOnLogout

Whether to unlock locked items while logging out
| Improve this Doc View Source

Logout(Boolean, Boolean)

Log out of the database

Declaration
void Logout(bool unlockOnLogout, bool async)
Parameters
Type Name Description
System.Boolean unlockOnLogout

Whether to unlock locked items while logging out
System.Boolean async

Whether to perform this action asynchronously

Extension Methods