Invite Builder

type

An invite that does not exist yet: configure it, then create it with 'the build result of'. Nothing is sent to Discord until then, so setting its properties costs no request.

6 syntaxesnet.dv8tion.jda.api.requests.restaction.InviteAction

6 / 6

Properties

propertyNumber since 5.0.0-a1

[the] invite max uses of %inviteaction%

%inviteaction%'s invite max uses

How many times the invite being built may be used before it expires (0 = unlimited).

change modes set

Helpful?

propertyNumber since 5.0.0-a1

[the] invite max age of %inviteaction%

%inviteaction%'s invite max age

How long the invite being built stays valid, in seconds (0 = never expires).

change modes set

Helpful?

propertyBoolean since 5.0.0-a1

[the] invite temporary of %inviteaction%

%inviteaction%'s invite temporary

Whether members joining through the invite being built are kicked once they disconnect, unless a role is assigned to them first.

change modes set

Helpful?

propertyBoolean since 5.0.0-a1

[the] invite unique of %inviteaction%

%inviteaction%'s invite unique

Whether a brand new invite is created instead of reusing an existing similar one.

change modes set

Helpful?

Expressions

expressionInvite Buildersince 5.0.0-a1

[a] new invite builder (in|for) [the] [channel] %guildchannel%

Creates an invite builder for a channel. The invite is only created on Discord once you read 'the build result of' it, which requires 'await'.

Helpful?

expressionInvite since 5.0.0-a1

[the] (build|built) result of [the] %inviteaction%

[the] built invite [from] [the] %inviteaction%

Creates the invite on Discord and returns it. Requires 'await'.

Building the same builder twice creates two invites.

Helpful?

Returned by

Syntaxes elsewhere in DiSky that return Invite Builder.

[a] new invite builder (in|for) [the] [channel] %guildchannel%Invite Builder

Documentation

Hand-written guides that cover Invite Builder.

BuildersConfigure a role, channel, message or invite locally, then create it on Discord in one line.Docs