Packages

c

ackcord.data

GuildMember

case class GuildMember(userId: UserId, guildId: GuildId, nick: Option[String], avatar: Option[String], roleIds: Seq[RoleId], joinedAt: Option[OffsetDateTime], premiumSince: Option[OffsetDateTime], deaf: Boolean, mute: Boolean, pending: Option[Boolean], communicationDisabledUntil: Option[OffsetDateTime]) extends GetUser with GetGuild with Product with Serializable

Represents a user in a guild.

userId

The user of this member.

guildId

The guild this member belongs to.

nick

The nickname of this user in this guild.

roleIds

The roles of this user.

joinedAt

When this user joined the guild.

premiumSince

When this user boosted the server.

deaf

If this user is deaf.

mute

IF this user is mute.

pending

True if the member hasn't gotten past the guild screening yet

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

Instance Constructors

  1. new GuildMember(userId: UserId, guildId: GuildId, nick: Option[String], avatar: Option[String], roleIds: Seq[RoleId], joinedAt: Option[OffsetDateTime], premiumSince: Option[OffsetDateTime], deaf: Boolean, mute: Boolean, pending: Option[Boolean], communicationDisabledUntil: Option[OffsetDateTime])

    userId

    The user of this member.

    guildId

    The guild this member belongs to.

    nick

    The nickname of this user in this guild.

    roleIds

    The roles of this user.

    joinedAt

    When this user joined the guild.

    premiumSince

    When this user boosted the server.

    deaf

    If this user is deaf.

    mute

    IF this user is mute.

    pending

    True if the member hasn't gotten past the guild screening yet

Value Members

  1. val avatar: Option[String]
  2. def channelPermissionsId(guild: GatewayGuild, channelId: GuildChannelId): Permission

    Calculate the permissions of this user in a channel given a guild.

  3. val communicationDisabledUntil: Option[OffsetDateTime]
  4. val deaf: Boolean
  5. def guild(implicit snapshot: CacheSnapshot): Option[GatewayGuild]

    The guild for this object

    The guild for this object

    Definition Classes
    GetGuild
  6. val guildId: GuildId
    Definition Classes
    GuildMember → GetGuild
  7. def hasRoleAboveId(guild: Guild, other: GuildMember): Boolean

    Check if this user has any roles above the passed in roles.

  8. def hasRoleAboveId(guild: Guild, others: Seq[RoleId]): Boolean

    Check if this user has any roles above the passed in roles.

  9. val joinedAt: Option[OffsetDateTime]
  10. val mute: Boolean
  11. val nick: Option[String]
  12. val pending: Option[Boolean]
  13. def permissions(guild: Guild): Permission

    Calculate the permissions of this user

  14. def permissionsWithOverridesId(guild: GatewayGuild, guildPermissions: Permission, channelId: GuildChannelId): Permission

    Calculate the permissions of this user in a channel.

  15. val premiumSince: Option[OffsetDateTime]
  16. def productElementNames: Iterator[String]
    Definition Classes
    Product
  17. val roleIds: Seq[RoleId]
  18. def user(implicit snapshot: CacheSnapshot): Option[User]

    The user for this object

    The user for this object

    Definition Classes
    GetUser
  19. val userId: UserId
    Definition Classes
    GuildMember → GetUser