Guild

type

A Discord server: members, channels, roles, boosts and settings.

34 syntaxesnet.dv8tion.jda.api.entities.Guild

34 / 34

Properties

propertylist of Member since 5.0.0-a1

Feeling lost? This is covered in the guide Components

[the] members of %guild%

%guild%'s members

The members of the guild. Without 'await' this is the cached member list, which may be incomplete depending on the bot's cache settings.

With 'await' the full member list is loaded online (this can be slow on large guilds).

mentioned inCache and await Linking

Helpful?

propertyVoicechannel since 5.0.0-a1

[the] afk channel of %guild%

%guild%'s afk channel

The AFK voice channel of the guild, or null if none is set.

change modes set

Helpful?

propertyNumber since 5.0.0-a1

[the] afk timeout of %guild%

%guild%'s afk timeout

The AFK timeout of the guild, in seconds (60, 300, 900, 1800 or 3600).

change modes set

Helpful?

propertyNumbersince 5.0.0-a1

[the] boost count of %guild%

%guild%'s boost count

How many members are currently boosting the guild.

Helpful?

propertyRolesince 5.0.0-a1

[the] boost role of %guild%

%guild%'s boost role

The booster role of the guild (granted to members who boost it), or null if none.

Helpful?

propertyTextsince 5.0.0-a1

[the] boost tier of %guild%

%guild%'s boost tier

The boost tier of the guild (e.g. 'none', 'tier 1', 'tier 2', 'tier 3').

Helpful?

propertyRolesince 5.0.0-a1

[the] bot role of %guild%

%guild%'s bot role

The integration role of this bot in the guild, or null if it has none.

Helpful?

propertyRolesince 5.0.0-a1

[the] everyone role of %guild%

%guild%'s everyone role

The @everyone (public) role of the guild.

Helpful?

propertyNumbersince 5.0.0-a1

[the] member count of %guild%

%guild%'s member count

The total number of members in the guild.

mentioned inComponents

Helpful?

propertyText since 5.0.0-a1

[the] verification level of %guild%

%guild%'s verification level

The verification level of the guild ('none', 'low', 'medium', 'high', 'very high').

change modes set

Helpful?

propertylist of Membersince 5.0.0-a1

[the] boosters of %guild%

%guild%'s boosters

The members currently boosting the guild.

Helpful?

propertylist of Scheduledeventsince 5.0.0-a1

[the] scheduled events of %guild%

%guild%'s scheduled events

All scheduled events of the guild.

Helpful?

propertylist of Textchannelsince 5.0.0-a1

[the] text channels of %guild%

%guild%'s text channels

All text channels of the guild.

Helpful?

propertylist of Voicechannelsince 5.0.0-a1

[the] voice channels of %guild%

%guild%'s voice channels

All voice channels of the guild.

Helpful?

propertylist of Newschannelsince 5.0.0-a1

[the] news channels of %guild%

%guild%'s news channels

All news (announcement) channels of the guild.

Helpful?

propertylist of Stagechannelsince 5.0.0-a1

[the] stage channels of %guild%

%guild%'s stage channels

All stage channels of the guild.

Helpful?

propertylist of Categorysince 5.0.0-a1

[the] categories of %guild%

%guild%'s categories

All channel categories of the guild.

Helpful?

propertylist of Guildchannelsince 5.0.0-a1

[the] guild channels of %guild%

%guild%'s guild channels

Every guild channel, including text, voice, stage, news and category channels.

Helpful?

propertylist of Rolesince 5.0.0-a1

[the] roles of %guild%

%guild%'s roles

All roles of the guild, ordered by position (highest first).

Helpful?

propertylist of RichCustomEmojisince 5.0.0-a1

[the] emojis of %guild%

%guild%'s emojis

All custom emojis of the guild.

Helpful?

propertylist of Guildsticker since 5.0.0-a1

[the] stickers of %guild%

%guild%'s stickers

All custom stickers of the guild.

Helpful?

propertylist of Invite since 5.0.0-a1

[the] invites of %guild%

%guild%'s invites

All active invites of the guild. Fetched online, so it requires 'await'.

mentioned inCache and await

Helpful?

propertylist of Webhook since 5.0.0-a1

Feeling lost? This is covered in the guide Webhook clients

[the] webhooks of %guild%

%guild%'s webhooks

All webhooks of the guild. Fetched online, so it requires 'await'.

mentioned inCache and await

Helpful?

propertyWelcome Screen since 5.0.0-a2

Feeling lost? This is covered in the guide Welcome screen

[the] welcome screen of %guild%

%guild%'s welcome screen

The welcome screen of the guild, fetched online, so it requires 'await'.

Fails when the guild is not a community guild.

Helpful?

propertylist of AutoMod Rule since 5.0.0-a2

Feeling lost? This is covered in the guide Managing rules

[the] automod rules of %guild%

%guild%'s automod rules

All AutoMod rules of the guild. Fetched online, so it requires 'await'.

Helpful?

propertylist of RichCustomEmoji since 5.0.0-a1

[the] emotes of %guild%

%guild%'s emotes

All custom emotes (emojis) of the guild, fetched online, so it requires 'await'.

Unlike 'emojis of %guild%' this never depends on the bot's cache.

mentioned inCache and await

Helpful?

propertylist of Ban since 5.0.0-a1

[the] bans of %guild%

%guild%'s bans

All bans of the guild. Fetched online, so it requires 'await'.

Only the first page (up to 1000 bans) is returned.

mentioned inCache and await

Helpful?

propertylist of Threadchannel since 5.0.0-a1

[the] active threads of %guild%

%guild%'s active threads

Every non-archived thread channel of the guild. Fetched online, so it requires 'await'.

mentioned inCache and await

Helpful?

propertylist of Logentry since 5.0.0-a1

[the] audit logs of %guild%

%guild%'s audit logs

The audit log entries of the guild. Fetched online, so it requires 'await'.

Only the most recent page (up to 100 entries) is returned.

mentioned inCache and await

Helpful?

propertyMember since 5.0.0-a1

[the] discord owner of %guild%

%guild%'s discord owner

The owner of the guild, as a member.

Without 'await' this is the cached member, which may be null if the owner is not cached; with 'await' it is fetched online.

mentioned inCache and await

Helpful?

propertyText since 5.0.0-a1

[the] name of %guild%

%guild%'s name

The name of a Discord entity: a user's or member's account name, a guild's name, a role/channel name, a bot's define-name. Registered on Skript's native Property.NAME, so the idiomatic "name of %x%" works without colliding. For a member's server nickname or display name, use "effective name".

Helpful?

propertyText since 5.0.0-a1

[the] avatar url of %guild%

%guild%'s avatar url

The avatar/icon URL of a Discord entity: a user/member's avatar, a guild's icon, a sticker's image, an application's icon... Co-owned across every type that has one, so "avatar url of %x%" works on any of them. Always a string (the image URL).

Helpful?

Getters

getterGuildsince 5.0.0-a1

guild with id %string% [(with|using) [the] [bot] %-bot%]

The guild with the given id, looked up in cache.

mentioned inGetting entities by id

Helpful?

Returned by

Syntaxes elsewhere in DiSky that return Guild.

[the] guild of %logentry%Audit Log Entry [the] guild of %automodrule%AutoMod Rule [the] guilds of %bot%Bot guild with id %string% [(with|using) [the] [bot] %-bot%]Guild [the] guild of %guildchannel%Guild Channel [the] guild of %guildsticker%Guild Sticker [the] guild of %member%Member [the] guild of %message%Message [the] guild of %role%Role [the] guild of %scheduledevent%Scheduled Event [the] mutual guilds of %user%User [the] guild of %webhook%Webhook [the] guild of %welcomescreen%Welcome Screen

Documentation

Hand-written guides that cover Guild.

Cache and awaitWhat the cache holds, the three rules that decide when a line needs await, and the reads that always do.Docs Getting entities by idLook a guild, role, user, member, channel or message up from its Discord id, from the cache or from Discord.Docs Webhook clientsCreate a webhook in a channel, retrieve the existing ones, or build a client from a webhook URL.Docs Managing rulesList a guild's AutoMod rules, edit them live, delete them, and react when one fires.Docs Welcome screenRead the welcome screen of a community guild and replace its description and channels.Docs ComponentsEvery rich markdown construct available in doc pages, demonstrated.Docs LinkingReferencing syntaxes, entities, events and other doc pages.Docs