tgstation-server 6.5.0
The /tg/station 13 server suite
Loading...
Searching...
No Matches
Public Member Functions | Properties | Private Attributes | List of all members
Tgstation.Server.Api.Models.DiscordConnectionStringBuilder Class Reference

ChatConnectionStringBuilder for ChatProvider.Discord. More...

Inheritance diagram for Tgstation.Server.Api.Models.DiscordConnectionStringBuilder:
Inheritance graph
[legend]
Collaboration diagram for Tgstation.Server.Api.Models.DiscordConnectionStringBuilder:
Collaboration graph
[legend]

Public Member Functions

 DiscordConnectionStringBuilder ()
 Initializes a new instance of the DiscordConnectionStringBuilder class. More...
 
 DiscordConnectionStringBuilder (string connectionString)
 Initializes a new instance of the DiscordConnectionStringBuilder 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? BotToken [get, set]
 The Discord bot token. More...
 
bool DeploymentBranding [get, set]
 If the tgstation-server logo is shown in deployment embeds. More...
 
DiscordDMOutputDisplayType DMOutputDisplay [get, set]
 The DiscordDMOutputDisplayType. More...
 
- Properties inherited from Tgstation.Server.Api.Models.Internal.ChatConnectionStringBuilder
abstract bool Valid [get]
 If the ChatConnectionStringBuilder evaluates to a valid ChatBotSettings.ConnectionString. More...
 

Private Attributes

readonly bool unusedFlag
 Currently unused. Note its origin in based meme before repurposing. More...
 

Detailed Description

ChatConnectionStringBuilder for ChatProvider.Discord.

Definition at line 11 of file DiscordConnectionStringBuilder.cs.

Constructor & Destructor Documentation

◆ DiscordConnectionStringBuilder() [1/2]

Tgstation.Server.Api.Models.DiscordConnectionStringBuilder.DiscordConnectionStringBuilder ( )

Initializes a new instance of the DiscordConnectionStringBuilder class.

Definition at line 40 of file DiscordConnectionStringBuilder.cs.

41 {
42 }

◆ DiscordConnectionStringBuilder() [2/2]

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

Initializes a new instance of the DiscordConnectionStringBuilder class.

Parameters
connectionStringThe connection string.

Definition at line 48 of file DiscordConnectionStringBuilder.cs.

49 {
50 if (connectionString == null)
51 throw new ArgumentNullException(nameof(connectionString));
52
53 var splits = connectionString.Split(';');
54
55 BotToken = splits.First();
56
57 if (splits.Length < 2 || !Enum.TryParse<DiscordDMOutputDisplayType>(splits[1], out var dMOutputDisplayType))
58 dMOutputDisplayType = DiscordDMOutputDisplayType.Always;
59 DMOutputDisplay = dMOutputDisplayType;
60
61 if (splits.Length > 2 && Int32.TryParse(splits[2], out Int32 basedMeme))
62 unusedFlag = Convert.ToBoolean(basedMeme);
63
64 if (splits.Length > 3 && Int32.TryParse(splits[3], out Int32 branding))
65 DeploymentBranding = Convert.ToBoolean(branding);
66 else
67 DeploymentBranding = true; // previous default behaviour
68 }
bool DeploymentBranding
If the tgstation-server logo is shown in deployment embeds.
readonly bool unusedFlag
Currently unused. Note its origin in based meme before repurposing.
DiscordDMOutputDisplayType DMOutputDisplay
The DiscordDMOutputDisplayType.
DiscordDMOutputDisplayType
When the DM output section of Discord deployment embeds should be shown.

References Tgstation.Server.Api.Models.DiscordConnectionStringBuilder.BotToken, Tgstation.Server.Api.Models.DiscordConnectionStringBuilder.DeploymentBranding, Tgstation.Server.Api.Models.DiscordConnectionStringBuilder.DMOutputDisplay, and Tgstation.Server.Api.Models.DiscordConnectionStringBuilder.unusedFlag.

Member Function Documentation

◆ ToString()

override string Tgstation.Server.Api.Models.DiscordConnectionStringBuilder.ToString ( )
virtual

Member Data Documentation

◆ unusedFlag

readonly bool Tgstation.Server.Api.Models.DiscordConnectionStringBuilder.unusedFlag
private

Currently unused. Note its origin in based meme before repurposing.

Definition at line 35 of file DiscordConnectionStringBuilder.cs.

Referenced by Tgstation.Server.Api.Models.DiscordConnectionStringBuilder.DiscordConnectionStringBuilder().

Property Documentation

◆ BotToken

string? Tgstation.Server.Api.Models.DiscordConnectionStringBuilder.BotToken
getset

◆ DeploymentBranding

bool Tgstation.Server.Api.Models.DiscordConnectionStringBuilder.DeploymentBranding
getset

If the tgstation-server logo is shown in deployment embeds.

Definition at line 25 of file DiscordConnectionStringBuilder.cs.

25{ get; set; }

Referenced by Tgstation.Server.Api.Models.DiscordConnectionStringBuilder.DiscordConnectionStringBuilder().

◆ DMOutputDisplay

DiscordDMOutputDisplayType Tgstation.Server.Api.Models.DiscordConnectionStringBuilder.DMOutputDisplay
getset

◆ Valid

override bool Tgstation.Server.Api.Models.DiscordConnectionStringBuilder.Valid
get

Definition at line 14 of file DiscordConnectionStringBuilder.cs.


The documentation for this class was generated from the following file: