Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Invite

Instant Invite Structure

Hierarchy

Index

Constructors

constructor

Properties

_keys

_keys: BaseSet<string> = keysInvite

_keysMerge

_keysMerge: BaseSet<string> = keysMergeInvite

Optional approximateMemberCount

approximateMemberCount: undefined | number

Optional approximatePresenceCount

approximatePresenceCount: undefined | number

Optional channel

channel: Channel

client

client: ShardClient

code

code: string = ""

Optional createdAt

createdAt: Date

Optional guild

guild: Guild

Optional inviter

inviter: User

Optional maxAge

maxAge: undefined | number

Optional maxUses

maxUses: undefined | number

Optional revoked

revoked: undefined | false | true

Optional targetUser

targetUser: User

Optional targetUserType

targetUserType: InviteTargetUserTypes

Optional temporary

temporary: undefined | false | true

Optional uses

uses: undefined | number

Accessors

createdAtUnix

  • get createdAtUnix(): number
  • Returns number

expiresAt

  • get expiresAt(): Date | null
  • Returns Date | null

expiresAtUnix

  • get expiresAtUnix(): number
  • Returns number

isVanity

  • get isVanity(): boolean
  • Returns boolean

longUrl

  • get longUrl(): string
  • Returns string

shardId

  • get shardId(): number
  • Returns number

url

  • get url(): string
  • Returns string

Methods

[inspect.custom]

  • [inspect.custom](): object

_getFromSnake

  • _getFromSnake(key: string): any
  • Parameters

    • key: string

    Returns any

_setFromSnake

  • _setFromSnake(key: string, value: any): any
  • Parameters

    • key: string
    • value: any

    Returns any

accept

  • accept(): Promise<any>
  • Returns Promise<any>

delete

  • delete(options?: DeleteInvite): Promise<Invite>
  • Parameters

    • Default value options: DeleteInvite = {}

    Returns Promise<Invite>

difference

  • difference(key: string, value: any): [boolean, any]
  • Parameters

    • key: string
    • value: any

    Returns [boolean, any]

differences

fetch

  • fetch(options?: FetchInvite): Promise<Invite>
  • Parameters

    • Default value options: FetchInvite = {}

    Returns Promise<Invite>

merge

mergeValue

  • mergeValue(key: string, value: any): void
  • Parameters

    • key: string
    • value: any

    Returns void

toJSON

  • toJSON(): object
  • Returns object

Generated using TypeDoc