Packages

c

ackcord.data

GatewayGuild

case class GatewayGuild(id: GuildId, name: String, icon: Option[String], iconHash: Option[String], splash: Option[String], discoverySplash: Option[String], ownerId: UserId, afkChannelId: Option[NormalVoiceGuildChannelId], afkTimeout: Int, widgetEnabled: Option[Boolean], widgetChannelId: Option[GuildChannelId], verificationLevel: VerificationLevel, defaultMessageNotifications: NotificationLevel, explicitContentFilter: FilterLevel, roles: SnowflakeMap[Role, Role], emojis: SnowflakeMap[Emoji, Emoji], features: Seq[GuildFeature], mfaLevel: MFALevel, applicationId: Option[ApplicationId], systemChannelId: Option[TextGuildChannelId], systemChannelFlags: SystemChannelFlags, rulesChannelId: Option[TextGuildChannelId], joinedAt: OffsetDateTime, large: Boolean, memberCount: Int, voiceStates: SnowflakeMap[User, VoiceState], members: SnowflakeMap[User, GuildMember], channels: SnowflakeMap[GuildChannel, GuildChannel], threads: SnowflakeMap[ThreadGuildChannel, ThreadGuildChannel], presences: SnowflakeMap[User, Presence], maxPresences: Option[Int], maxMembers: Option[Int], vanityUrlCode: Option[String], description: Option[String], banner: Option[String], premiumTier: PremiumTier, premiumSubscriptionCount: Option[Int], preferredLocale: Option[String], publicUpdatesChannelId: Option[TextGuildChannelId], maxVideoChannelUsers: Option[Int], nsfwLevel: NSFWLevel, stageInstances: SnowflakeMap[StageInstance, StageInstance], stickers: SnowflakeMap[Sticker, Sticker], guildScheduledEvents: SnowflakeMap[GuildScheduledEvent, GuildScheduledEvent], premiumProgressBarEnabled: Boolean) extends Guild with Product with Serializable

A guild or server in Discord received over the Gateway.

joinedAt

When the client joined the guild.

large

If this guild is above the large threshold.

memberCount

The amount of members in the guild.

voiceStates

The voice states of the guild.

members

The guild members in the guild.

channels

The channels in the guild.

presences

The presences in the guild.

publicUpdatesChannelId

The channel where admin and mods can see public updates are sent to public guilds.

maxVideoChannelUsers

The max amount of users in a video call.

Source
guild.scala
Linear Supertypes
Serializable, Product, Equals, Guild, UnknownStatusGuild, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GatewayGuild
  2. Serializable
  3. Product
  4. Equals
  5. Guild
  6. UnknownStatusGuild
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new GatewayGuild(id: GuildId, name: String, icon: Option[String], iconHash: Option[String], splash: Option[String], discoverySplash: Option[String], ownerId: UserId, afkChannelId: Option[NormalVoiceGuildChannelId], afkTimeout: Int, widgetEnabled: Option[Boolean], widgetChannelId: Option[GuildChannelId], verificationLevel: VerificationLevel, defaultMessageNotifications: NotificationLevel, explicitContentFilter: FilterLevel, roles: SnowflakeMap[Role, Role], emojis: SnowflakeMap[Emoji, Emoji], features: Seq[GuildFeature], mfaLevel: MFALevel, applicationId: Option[ApplicationId], systemChannelId: Option[TextGuildChannelId], systemChannelFlags: SystemChannelFlags, rulesChannelId: Option[TextGuildChannelId], joinedAt: OffsetDateTime, large: Boolean, memberCount: Int, voiceStates: SnowflakeMap[User, VoiceState], members: SnowflakeMap[User, GuildMember], channels: SnowflakeMap[GuildChannel, GuildChannel], threads: SnowflakeMap[ThreadGuildChannel, ThreadGuildChannel], presences: SnowflakeMap[User, Presence], maxPresences: Option[Int], maxMembers: Option[Int], vanityUrlCode: Option[String], description: Option[String], banner: Option[String], premiumTier: PremiumTier, premiumSubscriptionCount: Option[Int], preferredLocale: Option[String], publicUpdatesChannelId: Option[TextGuildChannelId], maxVideoChannelUsers: Option[Int], nsfwLevel: NSFWLevel, stageInstances: SnowflakeMap[StageInstance, StageInstance], stickers: SnowflakeMap[Sticker, Sticker], guildScheduledEvents: SnowflakeMap[GuildScheduledEvent, GuildScheduledEvent], premiumProgressBarEnabled: Boolean)

    joinedAt

    When the client joined the guild.

    large

    If this guild is above the large threshold.

    memberCount

    The amount of members in the guild.

    voiceStates

    The voice states of the guild.

    members

    The guild members in the guild.

    channels

    The channels in the guild.

    presences

    The presences in the guild.

    publicUpdatesChannelId

    The channel where admin and mods can see public updates are sent to public guilds.

    maxVideoChannelUsers

    The max amount of users in a video call.

Value Members

  1. def afkChannel: Option[NormalVoiceGuildChannel]

    Get the AFK channel of this guild.

  2. val afkChannelId: Option[NormalVoiceGuildChannelId]

    The channelId of the AFK channel.

    The channelId of the AFK channel.

    Definition Classes
    GatewayGuild → Guild
  3. val afkTimeout: Int

    The amount of seconds you need to be AFK before being moved to the AFK channel.

    The amount of seconds you need to be AFK before being moved to the AFK channel.

    Definition Classes
    GatewayGuild → Guild
  4. val applicationId: Option[ApplicationId]

    The application id if this guild is bot created.

    The application id if this guild is bot created.

    Definition Classes
    GatewayGuild → Guild
  5. val banner: Option[String]

    A banner hash for the guild.

    A banner hash for the guild.

    Definition Classes
    GatewayGuild → Guild
  6. val channels: SnowflakeMap[GuildChannel, GuildChannel]
  7. val defaultMessageNotifications: NotificationLevel

    The notification level for the guild.

    The notification level for the guild.

    Definition Classes
    GatewayGuild → Guild
  8. val description: Option[String]

    A description for a community guild.

    A description for a community guild.

    Definition Classes
    GatewayGuild → Guild
  9. val discoverySplash: Option[String]

    The discovery splash hash.

    The discovery splash hash.

    Definition Classes
    GatewayGuild → Guild
  10. val emojis: SnowflakeMap[Emoji, Emoji]

    The emojis of the guild.

    The emojis of the guild.

    Definition Classes
    GatewayGuild → Guild
  11. def everyoneRole: Role

    Get the everyone role in this guild.

    Get the everyone role in this guild.

    Definition Classes
    Guild
  12. val explicitContentFilter: FilterLevel

    The explicit content filter level for the guild.

    The explicit content filter level for the guild.

    Definition Classes
    GatewayGuild → Guild
  13. val features: Seq[GuildFeature]

    The enabled guild features.

    The enabled guild features.

    Definition Classes
    GatewayGuild → Guild
  14. val guildScheduledEvents: SnowflakeMap[GuildScheduledEvent, GuildScheduledEvent]
  15. val icon: Option[String]

    The icon hash.

    The icon hash.

    Definition Classes
    GatewayGuild → Guild
  16. val iconHash: Option[String]

    Used for template objects.

    Used for template objects.

    Definition Classes
    GatewayGuild → Guild
  17. val id: GuildId

    The id of the guild.

    The id of the guild.

    Definition Classes
    GatewayGuild → UnknownStatusGuild
  18. val joinedAt: OffsetDateTime
  19. val large: Boolean
  20. val maxMembers: Option[Int]

    The maximum amount of members in the guild.

    The maximum amount of members in the guild.

    Definition Classes
    GatewayGuild → Guild
  21. val maxPresences: Option[Int]

    The maximum amount of presences in the guild.

    The maximum amount of presences in the guild.

    Definition Classes
    GatewayGuild → Guild
  22. val maxVideoChannelUsers: Option[Int]

    The max amount of users in a video call.

    The max amount of users in a video call.

    Definition Classes
    GatewayGuild → Guild
  23. val memberCount: Int
  24. val members: SnowflakeMap[User, GuildMember]
  25. def mentionEveryone: String

    Get the everyone mention for this guild.

    Get the everyone mention for this guild.

    Definition Classes
    Guild
  26. val mfaLevel: MFALevel

    The MFA level.

    The MFA level.

    Definition Classes
    GatewayGuild → Guild
  27. val name: String

    The name of the guild.

    The name of the guild.

    Definition Classes
    GatewayGuild → Guild
  28. val nsfwLevel: NSFWLevel

    The guild NSFW level.

    The guild NSFW level.

    Definition Classes
    GatewayGuild → Guild
  29. def owner(implicit c: CacheSnapshot): Option[User]

    Get the owner this this guild.

    Get the owner this this guild.

    Definition Classes
    Guild
  30. val ownerId: UserId

    The userId of the owner.

    The userId of the owner.

    Definition Classes
    GatewayGuild → Guild
  31. val preferredLocale: Option[String]

    The preferred locale of a community guild.

    The preferred locale of a community guild.

    Definition Classes
    GatewayGuild → Guild
  32. val premiumProgressBarEnabled: Boolean
  33. val premiumSubscriptionCount: Option[Int]

    How many users that are boosting the server.

    How many users that are boosting the server.

    Definition Classes
    GatewayGuild → Guild
  34. val premiumTier: PremiumTier

    The premium tier of the guild.

    The premium tier of the guild.

    Definition Classes
    GatewayGuild → Guild
  35. val presences: SnowflakeMap[User, Presence]
  36. def productElementNames: Iterator[String]
    Definition Classes
    Product
  37. val publicUpdatesChannelId: Option[TextGuildChannelId]

    The channel where admin and mods can see public updates are sent to public guilds.

    The channel where admin and mods can see public updates are sent to public guilds.

    Definition Classes
    GatewayGuild → Guild
  38. val roles: SnowflakeMap[Role, Role]

    The roles of the guild.

    The roles of the guild.

    Definition Classes
    GatewayGuild → Guild
  39. val rulesChannelId: Option[TextGuildChannelId]

    The id for the channel where the rules of a guild are stored.

    The id for the channel where the rules of a guild are stored.

    Definition Classes
    GatewayGuild → Guild
  40. val splash: Option[String]

    The splash hash.

    The splash hash.

    Definition Classes
    GatewayGuild → Guild
  41. val stageInstances: SnowflakeMap[StageInstance, StageInstance]
  42. val stickers: SnowflakeMap[Sticker, Sticker]

    The stickers of the guild.

    The stickers of the guild.

    Definition Classes
    GatewayGuild → Guild
  43. def systemChannel: Option[TextGuildChannel]

    Get the system channel of this guild.

    Get the system channel of this guild. This is the first channel new users see when they join the guild.

  44. val systemChannelFlags: SystemChannelFlags

    The flags for the system channel.

    The flags for the system channel.

    Definition Classes
    GatewayGuild → Guild
  45. val systemChannelId: Option[TextGuildChannelId]

    The channel which notices like welcome and boost messages are sent to.

    The channel which notices like welcome and boost messages are sent to.

    Definition Classes
    GatewayGuild → Guild
  46. val threads: SnowflakeMap[ThreadGuildChannel, ThreadGuildChannel]
  47. def unavailable: Option[Boolean]
    Definition Classes
    Guild → UnknownStatusGuild
  48. val vanityUrlCode: Option[String]

    The vanity url code for the guild.

    The vanity url code for the guild.

    Definition Classes
    GatewayGuild → Guild
  49. val verificationLevel: VerificationLevel

    The verification level for the guild.

    The verification level for the guild.

    Definition Classes
    GatewayGuild → Guild
  50. val voiceStates: SnowflakeMap[User, VoiceState]
  51. def widgetChannel: Option[GuildChannel]

    Get the widget channel of this guild.

  52. val widgetChannelId: Option[GuildChannelId]

    The channel id for the widget.

    The channel id for the widget.

    Definition Classes
    GatewayGuild → Guild
  53. val widgetEnabled: Option[Boolean]

    If the widget is enabled.

    If the widget is enabled.

    Definition Classes
    GatewayGuild → Guild