mastodonk-core/fr.outadoc.mastodonk.api.entity/Instance

Instance

@Serializable

data class Instance(val uri: String, val title: String, val description: String, val shortDescription: String, val email: String, val version: String, val languages: List<String>, val areRegistrationsEnabled: Boolean, val isApprovalRequired: Boolean, val areInvitesEnabled: Boolean, val urls: InstanceUrls, val stats: InstanceStats, val thumbnail: String? = null, val contactAccount: Account? = null)

Information about the software instance of Mastodon running on this domain.

Constructors

constructor(uri: String, title: String, description: String, shortDescription: String, email: String, version: String, languages: List<String>, areRegistrationsEnabled: Boolean, isApprovalRequired: Boolean, areInvitesEnabled: Boolean, urls: InstanceUrls, stats: InstanceStats, thumbnail: String? = null, contactAccount: Account? = null)

Properties

areInvitesEnabled

val areInvitesEnabled: Boolean

Whether invites are enabled.

areRegistrationsEnabled

val areRegistrationsEnabled: Boolean

Whether registrations are enabled.

val contactAccount: Account? = null

A staff user that can be contacted, as an alternative to email.

val description: String

An admin-defined description of the instance.

val email: String

An email that may be contacted for any inquiries.

isApprovalRequired

val isApprovalRequired: Boolean

Whether registrations require moderator approval.

val languages: List<String>

Primary languages of the website and its staff.

shortDescription

val shortDescription: String

A shorter description of the instance defined by the admin.

val stats: InstanceStats

Statistics about how much information the instance contains.

val thumbnail: String? = null

URL of a banner image for the instance.

val title: String

The title of the instance.

val uri: String

The domain name of the instance.

val urls: InstanceUrls

URLs of interest for clients apps.

val version: String

The version of Mastodon installed on the instance.