Package discord4j.core.spec.legacy
Class LegacyInviteCreateSpec
java.lang.Object
discord4j.core.spec.legacy.LegacyInviteCreateSpec
- All Implemented Interfaces:
LegacyAuditSpec<discord4j.discordjson.json.InviteCreateRequest>
,LegacySpec<discord4j.discordjson.json.InviteCreateRequest>
public class LegacyInviteCreateSpec
extends Object
implements LegacyAuditSpec<discord4j.discordjson.json.InviteCreateRequest>
LegacySpec used to create guild channel
Invite
objects.- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiondiscord4j.discordjson.json.InviteCreateRequest
Returns the current audit log reason set on the spec.setMaxAge
(int maxAge) Sets the duration of the createdInvite
in seconds before expiration, or0
to never expire.setMaxUses
(int maxUses) Sets the maximum number of uses the createdInvite
has before expiring, or0
for unlimited uses.Sets the reason to show in the audit logs when the spec is built.setTargetApplicationId
(Snowflake targetApplicationId) Sets the id of the embedded application to open for this invite, required if `target_type` is 2, the application must have the `EMBEDDED` flag.setTargetType
(Invite.Type targetType) Sets the type of target for this voice channel invite.setTargetUserId
(Snowflake targetUserId) Sets the id of the user whose stream to display for this invite, required if `target_type` is 1, the user must be streaming in the channel.setTemporary
(boolean temporary) Sets whether the createdInvite
only grants temporary membership.setUnique
(boolean unique) Sets whether the createdInvite
is unique.
-
Constructor Details
-
LegacyInviteCreateSpec
public LegacyInviteCreateSpec()
-
-
Method Details
-
setMaxAge
Sets the duration of the createdInvite
in seconds before expiration, or0
to never expire. If unset, the default of 24 hours will be used.- Parameters:
maxAge
- The duration of the invite in seconds, or0
to never expire.- Returns:
- This spec.
-
setMaxUses
Sets the maximum number of uses the createdInvite
has before expiring, or0
for unlimited uses. If unset, the default is unlimited usages.- Parameters:
maxUses
- The maximum number of uses, or0
for unlimited usage.- Returns:
- This spec.
-
setTemporary
Sets whether the createdInvite
only grants temporary membership. This property isfalse
by default.- Parameters:
temporary
-true
if this invite is temporary,false
otherwise.- Returns:
- This spec.
-
setUnique
Sets whether the createdInvite
is unique. Iftrue
, 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.
-
setTargetType
Sets the type of target for this voice channel invite.- Parameters:
targetType
- The type of target for this voice channel invite.- Returns:
- This spec.
-
setTargetUserId
Sets the id of the user whose stream to display for this invite, required if `target_type` is 1, the user must be streaming in the channel.- Parameters:
targetUserId
- The id of the user whose stream to display for this invite.- Returns:
- This spec.
-
setTargetApplicationId
Sets the id of the embedded application to open for this invite, required if `target_type` is 2, the application must have the `EMBEDDED` flag.- Parameters:
targetApplicationId
- The id of the embedded application to open for this invite.- Returns:
- This spec.
-
setReason
Description copied from interface:LegacyAuditSpec
Sets the reason to show in the audit logs when the spec is built.- Specified by:
setReason
in interfaceLegacyAuditSpec<discord4j.discordjson.json.InviteCreateRequest>
- Parameters:
reason
- The audit log reason.- Returns:
- This spec.
-
getReason
Description copied from interface:LegacyAuditSpec
Returns the current audit log reason set on the spec.- Specified by:
getReason
in interfaceLegacyAuditSpec<discord4j.discordjson.json.InviteCreateRequest>
- Returns:
- The current audit log reason.
-
asRequest
public discord4j.discordjson.json.InviteCreateRequest asRequest()- Specified by:
asRequest
in interfaceLegacySpec<discord4j.discordjson.json.InviteCreateRequest>
-