Class ConnectorSettings

Namespace

XeroxDev.YTMDesktop.Companion.Settings

Assembly

XeroxDev.YTMDesktop.Companion.dll

The settings for the connector.

public class ConnectorSettings

Inheritance

object

ConnectorSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ConnectorSettings(string, int, string, string, string, string)

The settings for the connector.

public ConnectorSettings(string host, int port, string appId, string appName, string appVersion, string token = null)

Parameters

host string

The host name of the server (has to be without a protocol like http:// or https:// and can't have a trailing slash nor a port)
Hint: Some operating systems, such as Windows, may use an IPv6 address for localhost. This would result in a connection failure as the server is not listening on the IPv6 address.

port int

The port of the server.

appId string

The id of your app. Must be all lowercase with only alphanumeric characters, no spaces and between 2 and 32 characters.
Regex: ^[a-z0-9_\-]{2,32}$

appName string

The name of your app. Must be between 2 and 48 characters.

appVersion string

The version of your app. Must be semantic versioning compatible.

token string

The token to connect to the server (if available).

Exceptions

ArgumentNullException

Thrown when the host, app id or app name is null or empty.

ArgumentException

Thrown when the host contains a protocol, a port, the app id is not valid or the app name is too short or too long.

Properties

AppId

The id of your app. Must be all lowercase with only alphanumeric characters, no spaces and between 2 and 32 characters.
Regex: ^[a-z0-9_\-]{2,32}$

public string AppId { get; set; }

Property Value

string

AppName

The name of your app. Must be between 2 and 48 characters.

public string AppName { get; set; }

Property Value

string

AppVersion

The version of your app. Must be semantic versioning compatible.

public string AppVersion { get; set; }

Property Value

string

Host

The host name of the server (has to be without a protocol like http:// or https:// and can't have a trailing slash nor a port)
Hint: Some operating systems, such as Windows, may use an IPv6 address for localhost. This would result in a connection failure as the server is not listening on the IPv6 address.

public string Host { get; set; }

Property Value

string

Port

The port of the server.

public int Port { get; set; }

Property Value

int

Token

The token to connect to the server (if available).

public string Token { get; set; }

Property Value

string