Package discord4j.core.object

Class Invite

java.lang.Object

discord4j.core.object.Invite

All Implemented Interfaces:

DiscordObject

Direct Known Subclasses:

ExtendedInvite

public class Invite
extends Object
implements DiscordObject

A Discord invite.

See Also:

Invite Resource

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Invite.Type	Represents the various types of target user for an invite.

Constructor Summary

Constructors

Constructor	Description
Invite(GatewayDiscordClient gateway, discord4j.discordjson.json.InviteData data)	Constructs a Invite with an associated GatewayDiscordClient and Discord data.

Method Summary

Modifier and Type	Method	Description
Mono<Void>	delete()	Requests to delete this invite.
Mono<Void>	delete(String reason)	Requests to delete this invite while optionally specifying a reason.
OptionalInt	getApproximateMemberCount()	Gets an approximate count of total members, returned from the Routes.INVITE_GET endpoint when with_counts is true.
OptionalInt	getApproximatePresenceCount()	Gets an approximate count of online members, returned from the Routes.INVITE_GET endpoint when with_counts is true.
Mono<CategorizableChannel>	getChannel()	Requests to retrieve the channel this invite is associated to.
Mono<CategorizableChannel>	getChannel(EntityRetrievalStrategy retrievalStrategy)	Requests to retrieve the channel this invite is associated to, using the given retrieval strategy.
Snowflake	getChannelId()	Gets the ID of the channel this invite is associated to.
GatewayDiscordClient	getClient()	Returns the GatewayDiscordClient that created this object.
String	getCode()	Gets the invite code (unique ID).
Mono<Guild>	getGuild()	Requests to retrieve the guild this invite is associated to, if present.
Mono<Guild>	getGuild(EntityRetrievalStrategy retrievalStrategy)	Requests to retrieve the guild this invite is associated to, if present, using the given retrieval strategy.
Optional<Snowflake>	getGuildId()	Gets the ID of the guild this invite is associated to.
Optional<User>	getInviter()	Gets the user who created the invite, if present.
Optional<Snowflake>	getInviterId()	Gets the ID of the user who created the invite, if present.
Optional<Invite.Type>	getTargetType()	Gets the type of target for this voice channel invite, if present.
Optional<User>	getTargetUser()	Gets the target user this invite is associated to, if present.
Optional<Snowflake>	getTargetUserId()	Gets the ID of the target user this invite is associated to, if present.
Optional<Invite.Type>	getTargetUserType()	Deprecated. Use getTargetType()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Invite

public Invite(GatewayDiscordClient gateway,
              discord4j.discordjson.json.InviteData data)

Constructs a Invite with an associated GatewayDiscordClient and Discord data.

Parameters:

gateway - The GatewayDiscordClient associated to this object, must be non-null.

data - The raw data as represented by Discord, must be non-null.

Method Detail

getClient

public final GatewayDiscordClient getClient()

Description copied from interface: DiscordObject

Returns the GatewayDiscordClient that created this object. Methods in it are exclusively based on the entity cache or Store in use. Refer to calling getClient().rest() to access a DiscordClient that is capable of requesting entities directly from the REST API.

Specified by:

getClient in interface DiscordObject

Returns:

The GatewayDiscordClient associated to this object.

getCode

public final String getCode()

Gets the invite code (unique ID).

Returns:

The invite code (unique ID).

getGuildId

public final Optional<Snowflake> getGuildId()

Gets the ID of the guild this invite is associated to.

Returns:

The ID of the guild this invite is associated to.

getGuild

public final Mono<Guild> getGuild()

Requests to retrieve the guild this invite is associated to, if present.

Returns:

A Mono where, upon successful completion, emits the guild this invite is associated to. If an error is received, it is emitted through the Mono.

getGuild

public final Mono<Guild> getGuild(EntityRetrievalStrategy retrievalStrategy)

Requests to retrieve the guild this invite is associated to, if present, using the given retrieval strategy.

Parameters:

retrievalStrategy - the strategy to use to get the guild

Returns:

A Mono where, upon successful completion, emits the guild this invite is associated to. If an error is received, it is emitted through the Mono.

getChannelId

public final Snowflake getChannelId()

Gets the ID of the channel this invite is associated to.

Returns:

The ID of the channel this invite is associated to.

getChannel

public final Mono<CategorizableChannel> getChannel()

Requests to retrieve the channel this invite is associated to.

Returns:

A Mono where, upon successful completion, emits the channel this invite is associated to. If an error is received, it is emitted through the Mono.

getChannel

public final Mono<CategorizableChannel> getChannel(EntityRetrievalStrategy retrievalStrategy)

Requests to retrieve the channel this invite is associated to, using the given retrieval strategy.

Parameters:

retrievalStrategy - the strategy to use to get the channel

Returns:

A Mono where, upon successful completion, emits the channel this invite is associated to. If an error is received, it is emitted through the Mono.

getInviterId

public final Optional<Snowflake> getInviterId()

Gets the ID of the user who created the invite, if present.

Returns:

The ID of the user who created the invite, if present.

getInviter

public final Optional<User> getInviter()

Gets the user who created the invite, if present.

Returns:

The user who created the invite, if present.

getTargetUserId

public final Optional<Snowflake> getTargetUserId()

Gets the ID of the target user this invite is associated to, if present.

Returns:

The ID of the target user this invite is associated to, if present.

getTargetUser

public final Optional<User> getTargetUser()

Gets the target user this invite is associated to, if present.

Returns:

The target user this invite is associated to, if present.

getTargetUserType

@Deprecated
public final Optional<Invite.Type> getTargetUserType()

Deprecated.

Use getTargetType()

Gets the type of target user for this invite, if present.

Returns:

The type of target user for this invite, if present.

getTargetType

public final Optional<Invite.Type> getTargetType()

Gets the type of target for this voice channel invite, if present.

Returns:

The type of target for this voice channel invite, if present.

getApproximatePresenceCount

public final OptionalInt getApproximatePresenceCount()

Gets an approximate count of online members, returned from the Routes.INVITE_GET endpoint when with_counts is true.

Returns:

An approximate count of online members, returned from the Routes.INVITE_GET endpoint when with_counts is true.

getApproximateMemberCount

public final OptionalInt getApproximateMemberCount()

Gets an approximate count of total members, returned from the Routes.INVITE_GET endpoint when with_counts is true.

Returns:

An approximate count of total members, returned from the Routes.INVITE_GET endpoint when with_counts is true.

delete

public final Mono<Void> delete()

Requests to delete this invite.

Returns:

A Mono where, upon successful completion, emits nothing; indicating the invite has been deleted. If an error is received, it is emitted through the Mono.

delete

public final Mono<Void> delete(@Nullable
                               String reason)

Requests to delete this invite while optionally specifying a reason.

Parameters:

reason - The reason, if present.

Returns:

A Mono where, upon successful completion, emits nothing; indicating the invite has been deleted. If an error is received, it is emitted through the Mono.

toString

public String toString()

Overrides:

toString in class Object