clashJ/io.github.maicolantali.types.api.model.clans.clan/Clan

Clan

data class Clan(val warLeague: SimpleLeague, val capitalLeague: SimpleLeague, val memberList: List<ClanMember>, val tag: String, val warFrequency: WarFrequency, val clanLevel: Int, val warWinStreak: Int, val warWins: Int, val warTies: Int, val warLosses: Int, val clanPoints: Int, val requiredTownhallLevel: Int, val chatLanguage: Language?, val isFamilyFriendly: Boolean, val requiredTrophies: Int, val requiredBuilderBaseTrophies: Int, val isWarLogPublic: Boolean, val clanBuilderBasePoints: Int, val clanCapitalPoints: Int, val labels: List<Label>, val name: String, val location: Location?, val type: ClanType, val members: Int, val description: String, val clanCapital: ClanCapital, val badgeUrls: Badge)

Represents the Clan model of the Clash of Clans API. The Clan data class stores detailed information about a clan in the game.

Constructors

constructor(warLeague: SimpleLeague, capitalLeague: SimpleLeague, memberList: List<ClanMember>, tag: String, warFrequency: WarFrequency, clanLevel: Int, warWinStreak: Int, warWins: Int, warTies: Int, warLosses: Int, clanPoints: Int, requiredTownhallLevel: Int, chatLanguage: Language?, isFamilyFriendly: Boolean, requiredTrophies: Int, requiredBuilderBaseTrophies: Int, isWarLogPublic: Boolean, clanBuilderBasePoints: Int, clanCapitalPoints: Int, labels: List<Label>, name: String, location: Location?, type: ClanType, members: Int, description: String, clanCapital: ClanCapital, badgeUrls: Badge)

Properties

val badgeUrls: Badge

The badge URLs representing the clan's badge in different sizes.

val capitalLeague: SimpleLeague

The league information for the clan's capital.

val chatLanguage: Language?

The language used for clan chat.

clanBuilderBasePoints

val clanBuilderBasePoints: Int

The builder base points earned by the clan.

val clanCapital: ClanCapital

The information about the clan's capital.

clanCapitalPoints

val clanCapitalPoints: Int

The points earned by the clan's capital.

val clanLevel: Int

The level of the clan.

val clanPoints: Int

The total points earned by the clan.

val description: String

The description of the clan.

isFamilyFriendly

val isFamilyFriendly: Boolean

A flag indicating if the clan is family-friendly.

val isWarLogPublic: Boolean

A flag indicating if the clan's war log is public.

val labels: List<Label>

A list of Label objects categorizing the clan.

val location: Location?

The location of the clan.

val memberList: List<ClanMember>

A list of ClanMember objects representing the clan's members.

val members: Int

The total number of clan members.

val name: String

The name of the clan.

requiredBuilderBaseTrophies

val requiredBuilderBaseTrophies: Int

The minimum required builder base trophies to join the clan.

requiredTownhallLevel

val requiredTownhallLevel: Int

The minimum required town hall level to join the clan.

requiredTrophies

val requiredTrophies: Int

The minimum required trophies to join the clan.

val tag: String

The tag of the clan.

val type: ClanType

The type of the clan (open, invite-only, closed).

val warFrequency: WarFrequency

The frequency of clan wars.

val warLeague: SimpleLeague

The league information for clan wars.

val warLosses: Int

The total number of war losses.

val warTies: Int

The total number of war ties.

val warWins: Int

The total number of war wins.

val warWinStreak: Int

The current winning streak in clan wars.