Uses of Interface org.javacord.api.entity.permission.Role (Javacord 3.3.0 (api) Documentation)

Packages that use Role
Package	Description
org.javacord.api
org.javacord.api.entity.emoji
org.javacord.api.entity.emoji.internal
org.javacord.api.entity.message
org.javacord.api.entity.permission
org.javacord.api.entity.permission.internal
org.javacord.api.entity.server
org.javacord.api.entity.server.internal
org.javacord.api.entity.user
org.javacord.api.event.channel.server
org.javacord.api.event.server.emoji
org.javacord.api.event.server.role
org.javacord.api.util.internal

Uses of Role in org.javacord.api

Methods in org.javacord.api that return types with arguments of type Role
Modifier and Type	Method	Description
`default Optional<Role>`	DiscordApi.`getRoleById(long id)`	Gets a role by its id.
`default Optional<Role>`	DiscordApi.`getRoleById(String id)`	Gets a role by its id.
`default Collection<Role>`	DiscordApi.`getRoles()`	Gets a collection with all roles the bot knows.
`default Collection<Role>`	DiscordApi.`getRolesByName(String name)`	Gets a collection with all roles with the given name.
`default Collection<Role>`	DiscordApi.`getRolesByNameIgnoreCase(String name)`	Gets a collection with all roles with the given name.

Uses of Role in org.javacord.api.entity.emoji

Methods in org.javacord.api.entity.emoji that return types with arguments of type Role
Modifier and Type	Method	Description
`Optional<Collection<Role>>`	KnownCustomEmoji.`getWhitelistedRoles()`	Gets a list with all whitelisted roles.

Methods in org.javacord.api.entity.emoji with parameters of type Role
Modifier and Type	Method	Description
`CustomEmojiBuilder`	CustomEmojiBuilder.`addRoleToWhitelist(Role role)`	Adds a role to the whitelist.
`CustomEmojiUpdater`	CustomEmojiUpdater.`addRoleToWhitelist(Role role)`	Queues a role to be added to the whitelist.
`CustomEmojiUpdater`	CustomEmojiUpdater.`removeRoleFromWhitelist(Role role)`	Queues a role to be removed from the whitelist.
`CustomEmojiBuilder`	CustomEmojiBuilder.`setWhitelist(Role... roles)`	Sets the roles which should be whitelisted.
`CustomEmojiUpdater`	CustomEmojiUpdater.`setWhitelist(Role... roles)`	Sets the roles which should be whitelisted.
`default CompletableFuture<Void>`	KnownCustomEmoji.`updateWhitelist(Role... roles)`	Updates the whitelist of the emoji.

Method parameters in org.javacord.api.entity.emoji with type arguments of type Role
Modifier and Type	Method	Description
`CustomEmojiBuilder`	CustomEmojiBuilder.`setWhitelist(Collection<Role> roles)`	Sets the roles which should be whitelisted.
`CustomEmojiUpdater`	CustomEmojiUpdater.`setWhitelist(Collection<Role> roles)`	Sets the roles which should be whitelisted.
`default CompletableFuture<Void>`	KnownCustomEmoji.`updateWhitelist(Collection<Role> roles)`	Updates the whitelist of the emoji.

Uses of Role in org.javacord.api.entity.emoji.internal

Methods in org.javacord.api.entity.emoji.internal with parameters of type Role
Modifier and Type	Method	Description
`void`	CustomEmojiBuilderDelegate.`addRoleToWhitelist(Role role)`	Adds a role to the whitelist.
`void`	CustomEmojiUpdaterDelegate.`addRoleToWhitelist(Role role)`	Queues a role to be added to the whitelist.
`void`	CustomEmojiUpdaterDelegate.`removeRoleFromWhitelist(Role role)`	Queues a role to be removed from the whitelist.
`void`	CustomEmojiBuilderDelegate.`setWhitelist(Role... roles)`	Sets the roles which should be whitelisted.
`void`	CustomEmojiUpdaterDelegate.`setWhitelist(Role... roles)`	Sets the roles which should be whitelisted.

Method parameters in org.javacord.api.entity.emoji.internal with type arguments of type Role
Modifier and Type	Method	Description
`void`	CustomEmojiBuilderDelegate.`setWhitelist(Collection<Role> roles)`	Sets the roles which should be whitelisted.
`void`	CustomEmojiUpdaterDelegate.`setWhitelist(Collection<Role> roles)`	Sets the roles which should be whitelisted.

Uses of Role in org.javacord.api.entity.message

Methods in org.javacord.api.entity.message that return types with arguments of type Role
Modifier and Type	Method	Description
`List<Role>`	Message.`getMentionedRoles()`	Gets a list with all roles mentioned in this message.

Uses of Role in org.javacord.api.entity.permission

Methods in org.javacord.api.entity.permission that return types with arguments of type Role
Modifier and Type	Method	Description
`CompletableFuture<Role>`	RoleBuilder.`create()`	Creates the server text channel.
`default Optional<Role>`	Role.`getCurrentCachedInstance()`

Constructors in org.javacord.api.entity.permission with parameters of type Role
Constructor	Description
`RoleUpdater(Role role)`	Creates a new role updater.

Uses of Role in org.javacord.api.entity.permission.internal

Methods in org.javacord.api.entity.permission.internal that return types with arguments of type Role
Modifier and Type	Method	Description
`CompletableFuture<Role>`	RoleBuilderDelegate.`create()`	Creates the role.

Uses of Role in org.javacord.api.entity.server

Methods in org.javacord.api.entity.server that return Role
Modifier and Type	Method	Description
`default Role`	Server.`getEveryoneRole()`	Gets the @everyone role.

Methods in org.javacord.api.entity.server that return types with arguments of type Role
Modifier and Type	Method	Description
`default Optional<Role>`	Server.`getHighestRole(User user)`	Gets the highest role of the given user in this server.
`Optional<Role>`	Server.`getRoleById(long id)`	Gets a role by its id.
`default Optional<Role>`	Server.`getRoleById(String id)`	Gets a role by its id.
`List<Role>`	Server.`getRoles()`	Gets a sorted list (by position) with all roles of the server.
`List<Role>`	Server.`getRoles(User user)`	Gets a sorted list (by position) with all roles of the user in the server.
`default List<Role>`	Server.`getRolesByName(String name)`	Gets a sorted list (by position) with all roles with the given name.
`default List<Role>`	Server.`getRolesByNameIgnoreCase(String name)`	Gets a sorted list (by position) with all roles with the given name.

Methods in org.javacord.api.entity.server with parameters of type Role
Modifier and Type	Method	Description
`default CompletableFuture<Void>`	Server.`addRoleToUser(User user, Role role)`	Adds the given role to the given server member.
`CompletableFuture<Void>`	Server.`addRoleToUser(User user, Role role, String reason)`	Adds the given role to the given server member.
`ServerUpdater`	ServerUpdater.`addRoleToUser(User user, Role role)`	Queues a role to be assigned to the user.
`default boolean`	Server.`canManageRole(User user, Role target)`	Checks if the user can manage the target role.
`default CompletableFuture<Void>`	Server.`removeRoleFromUser(User user, Role role)`	Removes the given role from the given server member.
`CompletableFuture<Void>`	Server.`removeRoleFromUser(User user, Role role, String reason)`	Removes the given role from the given server member.
`ServerUpdater`	ServerUpdater.`removeRoleFromUser(User user, Role role)`	Queues a role to be removed from the user.

Method parameters in org.javacord.api.entity.server with type arguments of type Role
Modifier and Type	Method	Description
`ServerUpdater`	ServerUpdater.`addRolesToUser(User user, Collection<Role> roles)`	Queues a collection of roles to be assigned to the user.
`ServerUpdater`	ServerUpdater.`removeRolesFromUser(User user, Collection<Role> roles)`	Queues a collection of roles to be removed from the user.
`default CompletableFuture<Void>`	Server.`reorderRoles(List<Role> roles)`	Reorders the roles of the server.
`CompletableFuture<Void>`	Server.`reorderRoles(List<Role> roles, String reason)`	Reorders the roles of the server.
`ServerUpdater`	ServerUpdater.`reorderRoles(List<Role> roles)`	Sets the new order for the server's roles.
`default CompletableFuture<Void>`	Server.`updateRoles(User user, Collection<Role> roles)`	Updates the roles of a server member.
`default CompletableFuture<Void>`	Server.`updateRoles(User user, Collection<Role> roles, String reason)`	Updates the roles of a server member.

Uses of Role in org.javacord.api.entity.server.internal

Methods in org.javacord.api.entity.server.internal with parameters of type Role
Modifier and Type	Method	Description
`void`	ServerUpdaterDelegate.`addRoleToUser(User user, Role role)`	Queues a role to be assigned to the user.
`void`	ServerUpdaterDelegate.`removeRoleFromUser(User user, Role role)`	Queues a role to be removed from the user.

Method parameters in org.javacord.api.entity.server.internal with type arguments of type Role
Modifier and Type	Method	Description
`void`	ServerUpdaterDelegate.`addRolesToUser(User user, Collection<Role> roles)`	Queues a collection of roles to be assigned to the user.
`void`	ServerUpdaterDelegate.`removeRolesFromUser(User user, Collection<Role> roles)`	Queues a collection of roles to be removed from the user.
`void`	ServerUpdaterDelegate.`reorderRoles(List<Role> roles)`	Sets the new order for the server's roles.

Uses of Role in org.javacord.api.entity.user

Methods in org.javacord.api.entity.user that return types with arguments of type Role
Modifier and Type	Method	Description
`List<Role>`	User.`getRoles(Server server)`	Gets a sorted list (by position) with all roles of the user in the given server.

Methods in org.javacord.api.entity.user with parameters of type Role
Modifier and Type	Method	Description
`default CompletableFuture<Void>`	User.`addRole(Role role)`	Adds the given role to the user.
`default CompletableFuture<Void>`	User.`addRole(Role role, String reason)`	Adds the given role to the user.
`default boolean`	User.`canManageRole(Role role)`	Checks if the user can manage the target role.
`default CompletableFuture<Void>`	User.`removeRole(Role role)`	Removes the given role from the user.
`default CompletableFuture<Void>`	User.`removeRole(Role role, String reason)`	Removes the given role from the user.

Uses of Role in org.javacord.api.event.channel.server

Methods in org.javacord.api.event.channel.server that return types with arguments of type Role
Modifier and Type	Method	Description
`Optional<Role>`	ServerChannelChangeOverwrittenPermissionsEvent.`getRole()`	Gets the role which permissions were changed.

Uses of Role in org.javacord.api.event.server.emoji

Methods in org.javacord.api.event.server.emoji that return types with arguments of type Role
Modifier and Type	Method	Description
`Optional<Collection<Role>>`	KnownCustomEmojiChangeWhitelistedRolesEvent.`getNewWhitelistedRoles()`	Gets a list with the new whitelisted roles.
`Optional<Collection<Role>>`	KnownCustomEmojiChangeWhitelistedRolesEvent.`getOldWhitelistedRoles()`	Gets a list with the old whitelisted roles.

Uses of Role in org.javacord.api.event.server.role

Methods in org.javacord.api.event.server.role that return Role
Modifier and Type Method Description

Role RoleEvent.getRole()
Gets the role of the event.

Uses of Role in org.javacord.api.util.internal

Methods in org.javacord.api.util.internal with parameters of type Role
Modifier and Type	Method	Description
`static RoleUpdaterDelegate`	DelegateFactory.`createRoleUpdaterDelegate(Role role)`	Creates a new role updater delegate.
`RoleUpdaterDelegate`	DelegateFactoryDelegate.`createRoleUpdaterDelegate(Role role)`	Creates a new role updater delegate.