Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix manager docs #2271

Merged
merged 3 commits into from
Oct 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions src/main/java/net/dv8tion/jda/api/entities/Guild.java
Original file line number Diff line number Diff line change
Expand Up @@ -2009,9 +2009,6 @@ default RestAction<RichCustomEmoji> retrieveEmoji(@Nonnull CustomEmoji emoji)
* all properties and settings of the Guild.
* <br>You modify multiple fields in one request by chaining setters before calling {@link RestAction#queue() RestAction.queue()}.
*
* <p>This is a lazy idempotent getter. The manager is retained after the first call.
* This getter is not thread-safe and would require guards by the user.
*
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* If the currently logged in account does not have {@link net.dv8tion.jda.api.Permission#MANAGE_SERVER Permission.MANAGE_SERVER}
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -176,9 +176,6 @@ public interface PermissionOverride extends ISnowflake
* <br>In the PermissionOverrideAction you can modify the permissions of the override.
* You modify multiple fields in one request by chaining setters before calling {@link net.dv8tion.jda.api.requests.RestAction#queue() RestAction.queue()}.
*
* <p>This is a lazy idempotent getter. The manager is retained after the first call.
* This getter is not thread-safe and would require guards by the user.
*
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* If the currently logged in account does not have {@link net.dv8tion.jda.api.Permission#MANAGE_PERMISSIONS Permission.MANAGE_PERMISSIONS}
*
Expand Down
3 changes: 0 additions & 3 deletions src/main/java/net/dv8tion/jda/api/entities/Role.java
Original file line number Diff line number Diff line change
Expand Up @@ -230,9 +230,6 @@ default RoleAction createCopy()
* In the RoleManager, you can modify all its values.
* <br>You modify multiple fields in one request by chaining setters before calling {@link net.dv8tion.jda.api.requests.RestAction#queue() RestAction.queue()}.
*
* <p>This is a lazy idempotent getter. The manager is retained after the first call.
* This getter is not thread-safe and would require guards by the user.
*
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* If the currently logged in account does not have {@link net.dv8tion.jda.api.Permission#MANAGE_ROLES Permission.MANAGE_ROLES}
* @throws net.dv8tion.jda.api.exceptions.HierarchyException
Expand Down
3 changes: 0 additions & 3 deletions src/main/java/net/dv8tion/jda/api/entities/SelfUser.java
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,6 @@ default String getApplicationId()
* <br>This can be used to atomically set account fields (like avatar/username)
* You modify multiple fields in one request by chaining setters before calling {@link net.dv8tion.jda.api.requests.RestAction#queue() RestAction.queue()}.
*
* <p>This is a lazy idempotent getter. The manager is retained after the first call.
* This getter is not thread-safe and would require guards by the user.
*
* @return An AccountManager instance for the current account
*/
@Nonnull
Expand Down
3 changes: 0 additions & 3 deletions src/main/java/net/dv8tion/jda/api/entities/Webhook.java
Original file line number Diff line number Diff line change
Expand Up @@ -291,9 +291,6 @@ public interface Webhook extends ISnowflake
* The {@link WebhookManager WebhookManager} for this Webhook.
* <br>You can modify multiple fields in one request by chaining setters before calling {@link net.dv8tion.jda.api.requests.RestAction#queue() RestAction.queue()}.
*
* <p>This is a lazy idempotent getter. The manager is retained after the first call.
* This getter is not thread-safe and would require guards by the user.
*
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* If the currently logged in account does not have {@link net.dv8tion.jda.api.Permission#MANAGE_WEBHOOKS Permission.MANAGE_WEBHOOKS}
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,6 @@ public interface GuildChannel extends Channel, Comparable<GuildChannel>
* <br>In the ChannelManager, you can modify the name, topic and position of this GuildChannel.
* You modify multiple fields in one request by chaining setters before calling {@link net.dv8tion.jda.api.requests.RestAction#queue() RestAction.queue()}.
*
* <p>This is a lazy idempotent getter. The manager is retained after the first call.
* This getter is not thread-safe and would require guards by the user.
*
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* If the currently logged in account does not have {@link net.dv8tion.jda.api.Permission#MANAGE_CHANNEL Permission.MANAGE_CHANNEL}
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,9 +167,6 @@ public interface RichCustomEmoji extends CustomEmoji
* properties of the emoji like name and role restrictions.
* <br>You modify multiple fields in one request by chaining setters before calling {@link net.dv8tion.jda.api.requests.RestAction#queue() RestAction.queue()}.
*
* <p>This is a lazy idempotent getter. The manager is retained after the first call.
* This getter is not thread-safe and would require guards by the user.
*
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* If the currently logged in account does not have {@link net.dv8tion.jda.api.Permission#MANAGE_EMOJIS_AND_STICKERS Permission.MANAGE_EMOJIS_AND_STICKERS}
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -261,9 +261,6 @@ public boolean isSynced()
* <br>In the TemplateManager, you can modify the name or description of the template.
* You modify multiple fields in one request by chaining setters before calling {@link net.dv8tion.jda.api.requests.RestAction#queue() RestAction.queue()}.
*
* <p>This is a lazy idempotent getter. The manager is retained after the first call.
* This getter is not thread-safe and would require guards by the user.
*
* @throws IllegalStateException
* If the account is not in the template's guild
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@ public interface AccountManager extends Manager<AccountManager>

/**
* Resets the fields specified by the provided bit-flag patterns.
* You can specify a combination by using a bitwise OR concat of the flag constants.
* <br>Example: {@code manager.reset(AccountManager.NAME, AccountManager.AVATAR);}
*
* <p><b>Flag Constants:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,7 @@ public interface CustomEmojiManager extends Manager<CustomEmojiManager>
CustomEmojiManager reset(long fields);

/**
* Resets the fields specified by the provided bit-flag pattern.
* You can specify a combination by using a bitwise OR concat of the flag constants.
* Resets the fields specified by the provided bit-flag patterns.
* <br>Example: {@code manager.reset(CustomEmojiManager.NAME, CustomEmojiManager.ROLES);}
*
* <p><b>Flag Constants:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,6 @@ public interface GuildManager extends Manager<GuildManager>

/**
* Resets the fields specified by the provided bit-flag patterns.
* You can specify a combination by using a bitwise OR concat of the flag constants.
* <br>Example: {@code manager.reset(GuildManager.NAME, GuildManager.ICON);}
*
* <p><b>Flag Constants:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,7 @@ public interface GuildStickerManager extends Manager<GuildStickerManager>
GuildStickerManager reset(long fields);

/**
* Resets the fields specified by the provided bit-flag pattern.
* You can specify a combination by using a bitwise OR concat of the flag constants.
* Resets the fields specified by the provided bit-flag patterns.
* <br>Example: {@code manager.reset(GuildStickerManager.NAME, GuildStickerManager.TAGS);}
*
* <p><b>Flag Constants:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,6 @@ public interface PermOverrideManager extends Manager<PermOverrideManager>

/**
* Resets the fields specified by the provided bit-flag patterns.
* You can specify a combination by using a bitwise OR concat of the flag constants.
* <br>Example: {@code manager.reset(PermOverrideManager.ALLOWED, PermOverrideManager.DENIED);}
*
* <p><b>Flag Constants:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,6 @@ public interface RoleManager extends Manager<RoleManager>

/**
* Resets the fields specified by the provided bit-flag patterns.
* You can specify a combination by using a bitwise OR concat of the flag constants.
* <br>Example: {@code manager.reset(RoleManager.COLOR, RoleManager.NAME);}
*
* <p><b>Flag Constants:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,6 @@ public interface WebhookManager extends Manager<WebhookManager>

/**
* Resets the fields specified by the provided bit-flag patterns.
* You can specify a combination by using a bitwise OR concat of the flag constants.
* <br>Example: {@code manager.reset(WebhookManager.CHANNEL, WebhookManager.NAME);}
*
* <p><b>Flag Constants:</b>
Expand Down