Package com.mewna.catnip.entity.guild

Interface Invite

All Superinterfaces:
Entity
All Known Subinterfaces:
CreatedInvite
All Known Implementing Classes:
CreatedInviteImpl, InviteImpl
public interface Invite extends Entity
An invite to a guild.
Since:
9/14/18
Author:
natanbc

  • Method Details

    • code

      @Nonnull @CheckReturnValue String code()
      Returns:
      The code for this invite.

    • inviter

      @Nonnull @CheckReturnValue Invite.Inviter inviter()
      Returns:
      The person who created the invite.

    • guild

      @Nullable @CheckReturnValue Invite.InviteGuild guild()
      Returns:
      The guild the invite is for.

    • channel

      @Nonnull @CheckReturnValue Invite.InviteChannel channel()
      Returns:
      The channel the member is for.

    • approximatePresenceCount

      @Nonnegative int approximatePresenceCount()
      Returns:
      The approximate number of people online in the guild.

    • approximateMemberCount

      @Nonnegative int approximateMemberCount()
      Returns:
      The approximate number of people in the guild.

    • delete

      @Nonnull default io.reactivex.rxjava3.core.Single<Invite> delete(@Nullable String reason)
      Deletes the invite.
      Parameters:
      reason - The reason that will be displayed in audit log
      Returns:
      A Single that completes when the invite is deleted.

    • delete

      @Nonnull default io.reactivex.rxjava3.core.Single<Invite> delete()
      Deletes the invite.
      Returns:
      A Single that completes when the invite is deleted.