Tgstation.Server.Api.Models.Instance Class Reference

Metadata about a server instance. More...

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

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

Properties
string?	Path [get, set]
	The path to where the Instance is located. Can only be changed while the Instance is offline. Must not exist when the instance is created. More...
bool?	Online [get, set]
	If the Instance is online. More...
ConfigurationType?	ConfigurationType [get, set]
	If IConfigurationFiles can be used on the Instance. More...
uint?	AutoUpdateInterval [get, set]
	The time interval in minutes the repository is automatically pulled and compiles. 0 disables. More...
ushort?	ChatBotLimit [get, set]
	The maximum number of chat bots the Instance may contain. More...
Properties inherited from Tgstation.Server.Api.Models.NamedEntity
virtual ? string	Name [get, set]
	The name of the entity represented by the NamedEntity. More...
Properties inherited from Tgstation.Server.Api.Models.EntityId
virtual ? long	Id [get, set]
	The ID of the entity. More...

Detailed Description

Metadata about a server instance.

Definition at line 8 of file Instance.cs.

Property Documentation

AutoUpdateInterval

uint? Tgstation.Server.Api.Models.Instance.AutoUpdateInterval

getset

The time interval in minutes the repository is automatically pulled and compiles. 0 disables.

Definition at line 35 of file Instance.cs.

{ get; set; }

Referenced by Tgstation.Server.Host.Models.Instance.ToApi().

ChatBotLimit

ushort? Tgstation.Server.Api.Models.Instance.ChatBotLimit

getset

The maximum number of chat bots the Instance may contain.

Definition at line 41 of file Instance.cs.

{ get; set; }

Referenced by Tgstation.Server.Host.Controllers.ChatController.Create(), and Tgstation.Server.Host.Models.Instance.ToApi().

ConfigurationType

ConfigurationType? Tgstation.Server.Api.Models.Instance.ConfigurationType

getset

If IConfigurationFiles can be used on the Instance.

Definition at line 29 of file Instance.cs.

{ get; set; }

Referenced by Tgstation.Server.Host.Controllers.ConfigurationController.ForbidDueToModeConflicts(), and Tgstation.Server.Host.Models.Instance.ToApi().

Online

bool? Tgstation.Server.Api.Models.Instance.Online

getset

If the Instance is online.

Definition at line 22 of file Instance.cs.

{ get; set; }

Referenced by Tgstation.Server.Host.Models.Instance.ToApi().

Path

string? Tgstation.Server.Api.Models.Instance.Path

getset

The path to where the Instance is located. Can only be changed while the Instance is offline. Must not exist when the instance is created.

Definition at line 15 of file Instance.cs.

{ get; set; }

Referenced by Tgstation.Server.Host.Controllers.InstanceController.CreateDefaultInstance(), and Tgstation.Server.Host.Models.Instance.ToApi().

---

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

• src/Tgstation.Server.Api/Models/Instance.cs