Class HostedWolfClientOptions

Configuration options for hosted client.

Inheritance
Object
HostedWolfClientOptions
Namespace: TehGM.Wolfringo.Hosting
Assembly: Wolfringo.Hosting.dll
Syntax
public class HostedWolfClientOptions

Properties

| Improve this Doc View Source

AutoLogin

Whether the hosted client should automatically login when connected.

Declaration
public bool AutoLogin { get; set; }
Property Value
Type Description
Boolean
Remarks

Defaults to true.

| Improve this Doc View Source

AutoReconnectAttempts

How many times should client attempt to reconnect.

Declaration
public int AutoReconnectAttempts { get; set; }
Property Value
Type Description
Int32
Remarks

Value of 0 means reconnection will not be attempted. Negative values will be treated as infinite.

Defaults to 5 times.

| Improve this Doc View Source

AutoReconnectDelay

How long the client should wait before automatically reconnecting.

Declaration
public TimeSpan AutoReconnectDelay { get; set; }
Property Value
Type Description
TimeSpan
Remarks

Defaults to 500ms.

| Improve this Doc View Source

CloseOnCriticalError

Whether the application should close on critical error.

Declaration
public bool CloseOnCriticalError { get; set; }
Property Value
Type Description
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.

| Improve this Doc View Source

Device

Device to use when connecting.

Declaration
public WolfDevice Device { get; set; }
Property Value
Type Description
WolfDevice
Remarks

Defaults to DefaultDevice.

| Improve this Doc View Source

IgnoreOwnChatMessages

Whether the client should skip raising events for messages it sent.

Declaration
public bool IgnoreOwnChatMessages { get; set; }
Property Value
Type Description
Boolean
Remarks

Defaults to true.

| Improve this Doc View Source

LoginPassword

Password to authenticate with when automatically logging in.

Declaration
public string LoginPassword { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

LoginType

Login type to use when automatically logging in.

Declaration
public WolfLoginType LoginType { get; set; }
Property Value
Type Description
WolfLoginType
| Improve this Doc View Source

LoginUsername

Username to use as login when automatically logging in.

Declaration
public string LoginUsername { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

ServerURL

Server URL to connect to.

Declaration
public string ServerURL { get; set; }
Property Value
Type Description
String
Remarks

Defaults to DefaultServerURL.

| Improve this Doc View Source

Token

Token to use when connecting.

Declaration
public string Token { get; set; }
Property Value
Type Description
String
Remarks

If not set, the client will automatically generate a valid token.