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
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. val approximateMemberCount: Option[Int]
  2. val approximatePresenceCount: Option[Int]
  3. val channel: InviteChannel
  4. val code: String
  5. val createdAt: OffsetDateTime
  6. val expiresAt: Option[OffsetDateTime]
  7. val guild: Option[InviteGuild]
  8. val inviter: Option[User]
  9. val maxAge: Int
  10. val maxUses: Int
  11. def productElementNames: Iterator[String]
    Definition Classes
    Product
  12. val stageInstance: Option[InviteStageInstance]
  13. val targetApplication: Option[PartialApplication]
  14. val targetType: Option[InviteTargetType]
  15. val targetUser: Option[User]
  16. val temporary: Boolean
  17. val uses: Int