Interface IAuthenticationClient
Интерфейс, описывающий клиента для доступа к StockSharp сервису авторизации.
Namespace: StockSharp.Community
Assembly: StockSharp.Studio.Community.dll
Syntax
public interface IAuthenticationClient
Properties
Credentials
Информация о логине и пароле для доступа к StockSharp.
Declaration
ServerCredentials Credentials { get; }
Property Value
Type | Description |
---|---|
Ecng.ComponentModel.ServerCredentials |
IsLoggedIn
Прошел ли успешно авторизацию клиент.
Declaration
bool IsLoggedIn { get; }
Property Value
Type | Description |
---|---|
Boolean |
IsOnline
Online mode implementation.
Declaration
bool IsOnline { get; }
Property Value
Type | Description |
---|---|
Boolean |
NullableSessionId
Получить SessionId если была пройдена авторизация.
Declaration
Nullable<Guid> NullableSessionId { get; }
Property Value
Type | Description |
---|---|
Nullable<Guid> |
Product
Product.
Declaration
ProductInfoMessage Product { get; set; }
Property Value
Type | Description |
---|---|
ProductInfoMessage |
SessionId
Идентификатор сессии.
Declaration
Guid SessionId { get; }
Property Value
Type | Description |
---|---|
Guid |
UserId
Идентификатор пользователя для SessionId.
Declaration
long UserId { get; }
Property Value
Type | Description |
---|---|
Int64 |
Version
Version.
Declaration
string Version { get; set; }
Property Value
Type | Description |
---|---|
String |
Methods
Login()
Произвести вход в систему.
Declaration
Tuple<Guid, long> Login()
Returns
Type | Description |
---|---|
Tuple<Guid, Int64> | Идентификатор сессии. |
Login(ProductInfoMessage, String, String, SecureString, IPAddress)
Произвести вход в систему.
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 | Удаленный сетевой адрес. |
Returns
Type | Description |
---|---|
Tuple<Guid, Int64> | Идентификатор сессии. |
Logout()
Выйти из системы.
Declaration
void Logout()
Ping()
Ping.
Declaration
void Ping()
TryLoadCredentials()
Загрузить параметры из CompanyPath.
Declaration
bool TryLoadCredentials()
Returns
Type | Description |
---|---|
Boolean | true если загрузка была успешной, иначе, false. |