ChatConnectionStringBuilder for ChatProvider.Irc. More...

Inheritance diagram for Tgstation.Server.Api.Models.IrcConnectionStringBuilder:

Collaboration diagram for Tgstation.Server.Api.Models.IrcConnectionStringBuilder:

Public Member Functions
	IrcConnectionStringBuilder ()
	Initializes a new instance of the IrcConnectionStringBuilder class. More...

	IrcConnectionStringBuilder (string connectionString)
	Initializes a new instance of the IrcConnectionStringBuilder class. More...

override string	ToString ()
	Gets the ChatBotSettings.ConnectionString associated with the ChatConnectionStringBuilder. Returns The ChatBotSettings.ConnectionString associated with the ChatConnectionStringBuilder. More...

abstract override string	ToString ()
	Gets the ChatBotSettings.ConnectionString associated with the ChatConnectionStringBuilder. More...

Properties
override bool	Valid `[get]`

string?	Address `[get, set]`
	The IP address or URL of the IRC server. More...

ushort?	Port `[get, set]`
	The port the server runs on. More...

string?	Nickname `[get, set]`
	The nickname for the bot to use. More...

bool?	UseSsl `[get, set]`
	If the connection should be made using SSL. More...

IrcPasswordType?	PasswordType `[get, set]`
	The optional IrcPasswordType to use. More...

string?	Password `[get, set]`
	The optional password to use. More...

Properties inherited from Tgstation.Server.Api.Models.Internal.ChatConnectionStringBuilder
abstract bool	Valid `[get]`
	If the ChatConnectionStringBuilder evaluates to a valid ChatBotSettings.ConnectionString. More...

Detailed Description

ChatConnectionStringBuilder for ChatProvider.Irc.

Definition at line 12 of file IrcConnectionStringBuilder.cs.

Constructor & Destructor Documentation

◆ IrcConnectionStringBuilder() [1/2]

Tgstation.Server.Api.Models.IrcConnectionStringBuilder.IrcConnectionStringBuilder ( )

Initializes a new instance of the IrcConnectionStringBuilder class.

Definition at line 50 of file IrcConnectionStringBuilder.cs.

51 {

52 }

◆ IrcConnectionStringBuilder() [2/2]

Tgstation.Server.Api.Models.IrcConnectionStringBuilder.IrcConnectionStringBuilder ( string connectionString )

Initializes a new instance of the IrcConnectionStringBuilder class.

Parameters

connectionString The connection string.

Definition at line 58 of file IrcConnectionStringBuilder.cs.

        {
            if (connectionString == null)
                throw new ArgumentNullException(nameof(connectionString));
            var splits = connectionString.Split(';');
 
            Address = splits[0];
 
            if (splits.Length < 2)
                return;
 
            if (UInt16.TryParse(splits[1], out var port))
                Port = port;
 
            if (splits.Length < 3)
                return;
 
            Nickname = splits[2];
 
            if (splits.Length < 4)
                return;
 
            if (Int32.TryParse(splits[3], out var intSsl))
                UseSsl = Convert.ToBoolean(intSsl);
 
            if (splits.Length < 5)
                return;
            if (Enum.TryParse<IrcPasswordType>(splits[4], out var passwordType))
                switch (passwordType)
                {
                    case IrcPasswordType.NickServ:
                    case IrcPasswordType.Sasl:
                    case IrcPasswordType.Server:
                        PasswordType = passwordType;
                        break;
                    default:
                        break;
                }
 
            if (splits.Length < 6)
                return;
 
            var rest = new List<string>(splits);
            rest.RemoveRange(0, 5);
            Password = String.Join(";", rest);
        }

References Tgstation.Server.Api.Models.IrcConnectionStringBuilder.Address, Tgstation.Server.Api.Models.IrcConnectionStringBuilder.Nickname, Tgstation.Server.Api.Models.IrcConnectionStringBuilder.Password, Tgstation.Server.Api.Models.IrcConnectionStringBuilder.PasswordType, Tgstation.Server.Api.Models.IrcConnectionStringBuilder.Port, and Tgstation.Server.Api.Models.IrcConnectionStringBuilder.UseSsl.

Member Function Documentation

◆ ToString()

override string Tgstation.Server.Api.Models.IrcConnectionStringBuilder.ToString ( )

virtual

Gets the ChatBotSettings.ConnectionString associated with the ChatConnectionStringBuilder.

Returns: The ChatBotSettings.ConnectionString associated with the ChatConnectionStringBuilder.

Implements Tgstation.Server.Api.Models.Internal.ChatConnectionStringBuilder.

Definition at line 106 of file IrcConnectionStringBuilder.cs.

        {
            var sb = new StringBuilder();
            sb.Append(Address);
            sb.Append(';');
            sb.Append(Port);
            sb.Append(';');
            sb.Append(Nickname);
            sb.Append(';');
 
            if (UseSsl.HasValue)
                sb.Append(Convert.ToInt32(UseSsl.Value));
 
            if (PasswordType.HasValue)
            {
                sb.Append(';');
                sb.Append((int)PasswordType);
                sb.Append(';');
                sb.Append(Password);
            }
 
            return sb.ToString();
        }