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

Constructor Summary

Constructors

Constructor and Description
Invite(ServiceMediator serviceMediator, InviteBean data) Constructs a Invite with an associated ServiceMediator and Discord data.

Method Summary

Modifier and Type	Method and Description
Mono<Void>	delete() Requests to delete this invite.
Mono<Void>	delete(String reason) Requests to delete this invite while optionally specifying a reason.
Mono<TextChannel>	getChannel() Requests to retrieve the channel this invite is associated to.
Snowflake	getChannelId() Gets the ID of the channel this invite is associated to.
DiscordClient	getClient() Gets the DiscordClient associated to this object.
String	getCode() Gets the invite code (unique ID).
Mono<Guild>	getGuild() Requests to retrieve the guild this invite is associated to.
Snowflake	getGuildId() Gets the ID of the guild this invite is associated to.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Invite

public Invite(ServiceMediator serviceMediator,
              InviteBean data)

Constructs a Invite with an associated ServiceMediator and Discord data.

Parameters:

serviceMediator - The ServiceMediator 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 DiscordClient getClient()

Description copied from interface: DiscordObject

Gets the DiscordClient associated to this object.

Specified by:

getClient in interface DiscordObject

Returns:

The DiscordClient associated to this object.

getCode

public final String getCode()

Gets the invite code (unique ID).

Returns:

The invite code (unique ID).

getGuildId

public final 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.

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<TextChannel> 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.

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