Packages

c

ackcord.data

InviteWithMetadata

case class InviteWithMetadata(code: String, guild: Option[InviteGuild], channel: InviteChannel, inviter: Option[User], targetUser: Option[User], targetType: Option[InviteTargetType], targetApplication: Option[PartialApplication], approximatePresenceCount: Option[Int], approximateMemberCount: Option[Int], expiresAt: Option[OffsetDateTime], stageInstance: Option[InviteStageInstance], uses: Int, maxUses: Int, maxAge: Int, temporary: Boolean, createdAt: OffsetDateTime) extends Product with Serializable

An invite with extra information.

code

An invite code.

guild

The guild the invite is for.

channel

The channel the invite is for.

targetUser

The user who's stream should be displayed for this invite.

targetType

The type of target for this voice channel invite.

targetApplication

The embedded application to open for this voice channel embedded application invite.

approximatePresenceCount

Approximate amount of people online.

approximateMemberCount

Approximate amount of total members.

stageInstance

Stage instance if there is a public stage instance in the stage channel this invite leads to.

uses

How many times the invite has been used.

maxUses

How many times this invite can be used.

maxAge

The duration in seconds when the invite will expire

temporary

If this invite is temporary

createdAt

When this invite was created

Source
invite.scala
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InviteWithMetadata
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new InviteWithMetadata(code: String, guild: Option[InviteGuild], channel: InviteChannel, inviter: Option[User], targetUser: Option[User], targetType: Option[InviteTargetType], targetApplication: Option[PartialApplication], approximatePresenceCount: Option[Int], approximateMemberCount: Option[Int], expiresAt: Option[OffsetDateTime], stageInstance: Option[InviteStageInstance], uses: Int, maxUses: Int, maxAge: Int, temporary: Boolean, createdAt: OffsetDateTime)

    code

    An invite code.

    guild

    The guild the invite is for.

    channel

    The channel the invite is for.

    targetUser

    The user who's stream should be displayed for this invite.

    targetType

    The type of target for this voice channel invite.

    targetApplication

    The embedded application to open for this voice channel embedded application invite.

    approximatePresenceCount

    Approximate amount of people online.

    approximateMemberCount

    Approximate amount of total members.

    stageInstance

    Stage instance if there is a public stage instance in the stage channel this invite leads to.

    uses

    How many times the invite has been used.

    maxUses

    How many times this invite can be used.

    maxAge

    The duration in seconds when the invite will expire

    temporary

    If this invite is temporary

    createdAt

    When this invite was created

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val approximateMemberCount: Option[Int]
  5. val approximatePresenceCount: Option[Int]
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val channel: InviteChannel
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  9. val code: String
  10. val createdAt: OffsetDateTime
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. val expiresAt: Option[OffsetDateTime]
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. val guild: Option[InviteGuild]
  15. val inviter: Option[User]
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. val maxAge: Int
  18. val maxUses: Int
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  22. def productElementNames: Iterator[String]
    Definition Classes
    Product
  23. val stageInstance: Option[InviteStageInstance]
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. val targetApplication: Option[PartialApplication]
  26. val targetType: Option[InviteTargetType]
  27. val targetUser: Option[User]
  28. val temporary: Boolean
  29. val uses: Int
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped