discord4j.core.spec

Class InviteCreateSpec

java.lang.Object

discord4j.core.spec.InviteCreateSpec

All Implemented Interfaces:

AuditSpec<discord4j.discordjson.json.InviteCreateRequest>, Spec<discord4j.discordjson.json.InviteCreateRequest>

public class InviteCreateSpec
extends Object
implements AuditSpec<discord4j.discordjson.json.InviteCreateRequest>

Spec used to create guild channel Invite objects.

See Also:

Create Channel Invite

Constructor Summary

Constructors

Constructor and Description
InviteCreateSpec()

Method Summary

Modifier and Type	Method and Description
discord4j.discordjson.json.InviteCreateRequest	asRequest()
String	getReason() Returns the current audit log reason set on the spec.
InviteCreateSpec	setMaxAge(int maxAge) Sets the duration of the created Invite in seconds before expiration, or 0 to never expire.
InviteCreateSpec	setMaxUses(int maxUses) Sets the maximum number of uses the created Invite has before expiring, or 0 for unlimited uses.
InviteCreateSpec	setReason(String reason) Sets the reason to show in the audit logs when the spec is built.
InviteCreateSpec	setTemporary(boolean temporary) Sets whether the created Invite only grants temporary membership.
InviteCreateSpec	setUnique(boolean unique) Sets whether the created Invite is unique.

Methods inherited from class java.lang.Object

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

Constructor Detail

InviteCreateSpec

public InviteCreateSpec()

Method Detail

setMaxAge

public InviteCreateSpec setMaxAge(int maxAge)

Sets the duration of the created Invite in seconds before expiration, or 0 to never expire. If unset, the default of 24 hours will be used.

Parameters:

maxAge - The duration of the invite in seconds, or 0 to never expire.

Returns:

This spec.

setMaxUses

public InviteCreateSpec setMaxUses(int maxUses)

Sets the maximum number of uses the created Invite has before expiring, or 0 for unlimited uses. If unset, the default is unlimited usages.

Parameters:

maxUses - The maximum number of uses, or 0 for unlimited usage.

Returns:

This spec.

setTemporary

public InviteCreateSpec setTemporary(boolean temporary)

Sets whether the created Invite only grants temporary membership. This property is false by default.

Parameters:

temporary - true if this invite is temporary, false otherwise.

Returns:

This spec.

setUnique

public InviteCreateSpec setUnique(boolean unique)

Sets whether the created Invite is unique. If true, don't try to reuse a similar invite (useful for creating many unique one time use invites).

Parameters:

unique - true if the created invite is unique, false otherwise.

Returns:

This spec.

setReason

public InviteCreateSpec setReason(@Nullable
                                  String reason)

Description copied from interface: AuditSpec

Sets the reason to show in the audit logs when the spec is built.

Specified by:

setReason in interface AuditSpec<discord4j.discordjson.json.InviteCreateRequest>

Parameters:

reason - The audit log reason.

Returns:

This spec.

getReason

@Nullable
public String getReason()

Description copied from interface: AuditSpec

Returns the current audit log reason set on the spec.

Specified by:

getReason in interface AuditSpec<discord4j.discordjson.json.InviteCreateRequest>

Returns:

The current audit log reason.

asRequest

public discord4j.discordjson.json.InviteCreateRequest asRequest()

Specified by:

asRequest in interface Spec<discord4j.discordjson.json.InviteCreateRequest>