Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InviteMethods

Methods for interacting with invites

Hierarchy

  • InviteMethods

Index

Constructors

Properties

Methods

Constructors

constructor

  • Create a new Invite Method Handler

    Usually SnowTransfer creates a method handler for you, this is here for completion

    You can access the methods listed via client.invite.method, where client is an initialized SnowTransfer instance

    Parameters

    Returns <internal>.InviteMethods

Properties

requestHandler

requestHandler: <internal>.RequestHandler

Methods

deleteInvite

getInvite

  • getInvite(inviteId: string, options?: { with_counts?: boolean; with_expiration?: boolean }): Promise<<internal>.Invite>

  • Get the invite data on an invite id

    Parameters

    • inviteId: string

      Id of the invite

    • Optional options: { with_counts?: boolean; with_expiration?: boolean }

      Options for when properties are set to true you get an invite object with additional approximate_presence_count and approximate_member_count fields and when the invite expires

      • Optional with_counts?: boolean
      • Optional with_expiration?: boolean

    Returns Promise<<internal>.Invite>

Generated using TypeDoc