Interface IAuthenticationClient

The interface describing a client for access to the StockSharp authentication service.

Namespace: StockSharp.Community
Assembly: StockSharp.Studio.Community.dll
Syntax
public interface IAuthenticationClient

Properties

Credentials

Information about the login and password for access to the StockSharp.

Declaration
ServerCredentials Credentials { get; }
Property Value
Type Description
Ecng.ComponentModel.ServerCredentials

IsLoggedIn

Has the client successfully authenticated.

Declaration
bool IsLoggedIn { get; }
Property Value
Type Description
Boolean

IsOnline

Online mode implementation.

Declaration
bool IsOnline { get; }
Property Value
Type Description
Boolean

NullableSessionId

To get the SessionId if the user was authorized.

Declaration
Nullable<Guid> NullableSessionId { get; }
Property Value
Type Description
Nullable<Guid>

Product

Product.

Declaration
ProductInfoMessage Product { get; set; }
Property Value
Type Description
ProductInfoMessage

SessionId

Session ID.

Declaration
Guid SessionId { get; }
Property Value
Type Description
Guid

UserId

The user identifier for SessionId.

Declaration
long UserId { get; }
Property Value
Type Description
Int64

Version

Version.

Declaration
string Version { get; set; }
Property Value
Type Description
String

Methods

Login()

To log in.

Declaration
Tuple<Guid, long> Login()
Returns
Type Description
Tuple<Guid, Int64>

Session ID.

Login(ProductInfoMessage, String, String, SecureString, IPAddress)

To log in.

Declaration
Tuple<Guid, long> Login(ProductInfoMessage product, string version, string login, SecureString password, IPAddress clientAddress)
Parameters
Type Name Description
ProductInfoMessage product

Product.
String version

Version.
String login

Login.
SecureString password

Password.
IPAddress clientAddress

Remote network address.
Returns
Type Description
Tuple<Guid, Int64>

Session ID.

Logout()

Logout.

Declaration
void Logout()

Ping()

Ping.

Declaration
void Ping()

TryLoadCredentials()

Try load credentials from CompanyPath.

Declaration
bool TryLoadCredentials()
Returns
Type Description
Boolean

true if the specified credentials was loaded successfully, otherwise, false.

Extension Methods