Class HostedWolfClientOptions
Configuration options for hosted client.
Inheritance
Namespace: TehGM.Wolfringo.Hosting
Assembly: Wolfringo.Hosting.dll
Syntax
public class HostedWolfClientOptions
Properties
| Improve this Doc View SourceAutoLogin
Whether the hosted client should automatically login when connected.
Declaration
public bool AutoLogin { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Defaults to true.
AutoReconnectAttempts
How many times should client attempt to reconnect.
Declaration
public int AutoReconnectAttempts { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Remarks
Value of 0 means reconnection will not be attempted. Negative values will be treated as infinite.
Defaults to 5 times.
AutoReconnectDelay
How long the client should wait before automatically reconnecting.
Declaration
public TimeSpan AutoReconnectDelay { get; set; }
Property Value
Type | Description |
---|---|
System.TimeSpan |
Remarks
Defaults to 500ms.
CloseOnCriticalError
Whether the application should close on critical error.
Declaration
public bool CloseOnCriticalError { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Setting this to true might be useful if the application is running as a service, so it's auto-restarted.
Defaults to false.
Device
Device to use when connecting.
Declaration
public WolfDevice Device { get; set; }
Property Value
Type | Description |
---|---|
WolfDevice |
Remarks
Defaults to DefaultDevice.
IgnoreOwnChatMessages
Whether the client should skip raising events for messages it sent.
Declaration
public bool IgnoreOwnChatMessages { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Defaults to true.
LoginPassword
Password to authenticate with when automatically logging in.
Declaration
public string LoginPassword { get; set; }
Property Value
Type | Description |
---|---|
System.String |
LoginType
Login type to use when automatically logging in.
Declaration
public WolfLoginType LoginType { get; set; }
Property Value
Type | Description |
---|---|
WolfLoginType |
LoginUsername
Username to use as login when automatically logging in.
Declaration
public string LoginUsername { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ServerURL
Server URL to connect to.
Declaration
public string ServerURL { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Defaults to DefaultServerURL.
Token
Token to use when connecting.
Declaration
public string Token { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
If not set, the client will automatically generate a valid token.