Type alias CreateInviteData

CreateInviteData: {
    max_age?: number;
    max_uses?: number;
    target_application_id?: string;
    target_type?: InviteTarget;
    target_user_id?: string;
    temporary?: boolean;
    unique?: boolean;
}

Type declaration

  • Optional max_age?: number

    max age of the invite in seconds

  • Optional max_uses?: number

    max uses of the invite

  • Optional target_application_id?: string

    ID of the application to open for this invite. Required if target_type is 2. The application must have the EMBEDDED flag.

  • Optional target_type?: InviteTarget

    The type of target for this voice channel invite

  • Optional target_user_id?: string

    User ID of who's stream to display in the voice channel. Required if target_type is 1. User must be streaming in the channel

  • Optional temporary?: boolean

    if this invite only allows temporary membership

  • Optional unique?: boolean

    does not try to re-use similar invites when true (useful for creating many one-time invites)

Generated using TypeDoc