Class

ackcord.data

GuildMember

Related Doc: package data

Permalink

case class GuildMember(userId: UserId, guildId: GuildId, nick: Option[String], roleIds: Seq[RoleId], joinedAt: OffsetDateTime, deaf: Boolean, mute: Boolean) 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.

deaf

If this user is deaf.

mute

IF this user is mute.

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

Instance Constructors

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

    Permalink

    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.

    deaf

    If this user is deaf.

    mute

    IF this user is mute.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def channelPermissions[F[_]](channelId: ChannelId)(implicit c: CacheSnapshot[F], F: Monad[F]): F[Permission]

    Permalink

    Calculate the permissions of this user in a channel.

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. val deaf: Boolean

    Permalink

    If this user is deaf.

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  11. def guild[F[_]](implicit snapshot: CacheSnapshot[F]): OptionT[F, Guild]

    Permalink

    The guild for this object

    The guild for this object

    Definition Classes
    GetGuild

  12. val guildId: GuildId

    Permalink

    The guild this member belongs to.

    The guild this member belongs to.

    Definition Classes
    GuildMember → GetGuild

  13. def hasRoleAbove[F[_]](other: GuildMember)(implicit c: CacheSnapshot[F], F: Monad[F]): F[Boolean]

    Permalink

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

  14. def hasRoleAbove[F[_]](others: Seq[RoleId])(implicit c: CacheSnapshot[F], F: Monad[F]): F[Boolean]

    Permalink

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

  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  16. val joinedAt: OffsetDateTime

    Permalink

    When this user joined the guild.

  17. val mute: Boolean

    Permalink

    IF this user is mute.

  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  19. val nick: Option[String]

    Permalink

    The nickname of this user in this guild.

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. def permissions(guild: Guild): Permission

    Permalink

    Calculate the permissions of this user

  23. def permissions[F[_]](implicit c: CacheSnapshot[F], F: Functor[F]): F[Permission]

    Permalink

    Calculate the permissions of this user

  24. def permissionsWithOverrides[F[_]](guildPermissions: Permission, channelId: ChannelId)(implicit c: CacheSnapshot[F], F: Monad[F]): F[Permission]

    Permalink

    Calculate the permissions of this user in a channel.

  25. val roleIds: Seq[RoleId]

    Permalink

    The roles of this user.

  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  27. def user[F[_]](implicit snapshot: CacheSnapshot[F]): OptionT[F, User]

    Permalink

    The user for this object

    The user for this object

    Definition Classes
    GetUser

  28. val userId: UserId

    Permalink

    The user of this member.

    The user of this member.

    Definition Classes
    GuildMember → GetUser

  29. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from GetGuild

Inherited from GetUser

Inherited from AnyRef

Inherited from Any

Ungrouped