LuckPermsApi (luckperms-api 4.3 API)

```
public interface LuckPermsApi
```
The LuckPerms API.
This interface is the base of the entire API package. All API functions are accessed via this interface.

An instance can be obtained via LuckPerms.getApi(), or the platforms Services Manager.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default Node.Builder`	`buildNode(@NonNull String permission)` Returns a permission builder instance
`default void`	`cleanupUser(@NonNull User user)` Unload a user from the internal storage, if they're not currently online.
`@NonNull ActionLogger`	`getActionLogger()` Gets the `ActionLogger`.
`@NonNull LPConfiguration`	`getConfiguration()` Gets a representation of the plugins configuration
`default @NonNull ContextSet`	`getContextForPlayer(@NonNull Object player)` Gets set of contexts applicable to a player using the platforms `ContextCalculator`s.
`default @NonNull Optional<Contexts>`	`getContextForUser(@NonNull User user)` Gets a calculated context instance for the user using the rules of the platform.
`@NonNull ContextManager`	`getContextManager()` Gets the `ContextManager`.
`default @NonNull Contexts`	`getContextsForPlayer(@NonNull Object player)` Gets a Contexts instance for the player using the platforms `ContextCalculator`s.
`@NonNull EventBus`	`getEventBus()` Gets the `EventBus`, used for subscribing to internal LuckPerms events.
`default @Nullable Group`	`getGroup(@NonNull String name)` Gets a wrapped group object from the group storage
`@NonNull GroupManager`	`getGroupManager()` Gets the `GroupManager`, responsible for managing `Group` instances.
`default @NonNull Set<Group>`	`getGroups()` Gets a set of all loaded groups.
`default @NonNull Optional<Group>`	`getGroupSafe(@NonNull String name)` Gets a wrapped group object from the group storage.
`@NonNull Optional<MessagingService>`	`getMessagingService()` Gets the `MessagingService`, if present.
`@NonNull MetaStackFactory`	`getMetaStackFactory()` Gets the `MetaStackFactory`.
`@NonNull NodeFactory`	`getNodeFactory()` Gets the `NodeFactory`.
`@NonNull PlatformInfo`	`getPlatformInfo()` Gets information about the platform LuckPerms is running on.
`@NonNull Storage`	`getStorage()` Gets an object representing the plugins primary `Storage` backend.
`default @Nullable Track`	`getTrack(@NonNull String name)` Gets a wrapped track object from the track storage
`@NonNull TrackManager`	`getTrackManager()` Gets the `TrackManager`, responsible for managing `Track` instances.
`default @NonNull Set<Track>`	`getTracks()` Gets a set of all loaded tracks.
`default @NonNull Optional<Track>`	`getTrackSafe(@NonNull String name)` Gets a wrapped track object from the track storage.
`default @Nullable User`	`getUser(@NonNull String name)` Gets a wrapped user object from the user storage
`default @Nullable User`	`getUser(@NonNull UUID uuid)` Gets a wrapped user object from the user storage
`@NonNull UserManager`	`getUserManager()` Gets the `UserManager`, responsible for managing `User` instances.
`default @NonNull Set<User>`	`getUsers()` Gets a set of all loaded users.
`default @NonNull Optional<User>`	`getUserSafe(@NonNull String name)` Gets a wrapped user object from the user storage.
`default @NonNull Optional<User>`	`getUserSafe(@NonNull UUID uuid)` Gets a wrapped user object from the user storage.
`@NonNull UuidCache`	`getUuidCache()` Deprecated. this feature is now handled internally - and the API returns a No-op implementation of this class.
`default boolean`	`isGroupLoaded(@NonNull String name)` Check if a group is loaded in memory
`default boolean`	`isTrackLoaded(@NonNull String name)` Check if a track is loaded in memory
`default boolean`	`isUserLoaded(@NonNull UUID uuid)` Check if a user is loaded in memory
`default LogEntry.Builder`	`newLogEntryBuilder()` Returns a new LogEntry Builder instance
`default void`	`registerContextCalculator(@NonNull ContextCalculator<?> calculator)` Register a custom context calculator to the server
`void`	`registerMessengerProvider(@NonNull MessengerProvider messengerProvider)` Registers a `MessengerProvider` for use by the platform.
`@NonNull CompletableFuture<Void>`	`runUpdateTask()` Schedules the execution of an update task, and returns an encapsulation of the task as a `CompletableFuture`.

- Method Detail
  - getPlatformInfo
```
@NonNull PlatformInfo getPlatformInfo()
```
    Gets information about the platform LuckPerms is running on.
    
    Returns:
    
    the platform info
    
    Since:
    
    4.0
  - getUserManager
```
@NonNull UserManager getUserManager()
```
    Gets the UserManager, responsible for managing User instances.
    This manager can be used to retrieve instances of User by uuid or name, or query all loaded users.
    
    The storage instance should be used to load/create/save users.
    
    Returns:
    
    the user manager
    
    Since:
    
    4.0
  - getGroupManager
```
@NonNull GroupManager getGroupManager()
```
    Gets the GroupManager, responsible for managing Group instances.
    This manager can be used to retrieve instances of Group by name, or query all loaded groups.
    
    The storage instance should be used to load/create/save/delete groups.
    
    Returns:
    
    the group manager
    
    Since:
    
    4.0
  - getTrackManager
```
@NonNull TrackManager getTrackManager()
```
    Gets the TrackManager, responsible for managing Track instances.
    This manager can be used to retrieve instances of Track by name, or query all loaded tracks.
    
    The storage instance should be used to load/create/save/delete tracks.
    
    Returns:
    
    the track manager
    
    Since:
    
    4.0
  - runUpdateTask
```
@NonNull CompletableFuture<Void> runUpdateTask()
```
    Schedules the execution of an update task, and returns an encapsulation of the task as a CompletableFuture.
    The exact actions performed in an update task remains an implementation detail of the plugin, however, as a minimum, it is expected to perform a full reload of user, group and track data, and ensure that any changes are fully applied and propagated.
    
    Returns:
    
    a future
    
    Since:
    
    4.0
  - getEventBus
```
@NonNull EventBus getEventBus()
```
    Gets the EventBus, used for subscribing to internal LuckPerms events.
    
    Returns:
    
    the event bus
    
    Since:
    
    3.0
  - getConfiguration
```
@NonNull LPConfiguration getConfiguration()
```
    Gets a representation of the plugins configuration
    
    Returns:
    
    the configuration
  - getStorage
```
@NonNull Storage getStorage()
```
    Gets an object representing the plugins primary Storage backend.
    The instance propagates calls to the internal DAO (Data Access Object), and applies any changes to the storage provider.
    
    Returns:
    
    a storage instance
    
    Since:
    
    2.14
  - getMessagingService
```
@NonNull Optional<MessagingService> getMessagingService()
```
    Gets the MessagingService, if present.
    The MessagingService is used to dispatch updates throughout a network of servers running the plugin.
    
    Not all instances of LuckPerms will have a messaging service setup and configured, but it is recommended that all users of the API account for and make use of this.
    
    Returns:
    
    the messaging service instance, if present.
  - registerMessengerProvider
```
void registerMessengerProvider(@NonNull MessengerProvider messengerProvider)
```
    Registers a MessengerProvider for use by the platform.
    Note that the mere action of registering a provider doesn't necessarily mean that it will be used.
    
    Parameters:
    
    messengerProvider - the messenger provider.
    
    Since:
    
    4.1
  - getActionLogger
```
@NonNull ActionLogger getActionLogger()
```
    Gets the ActionLogger.
    The action logger is responsible for saving and broadcasting defined actions occurring on the platform.
    
    Returns:
    
    the action logger
    
    Since:
    
    4.1
  - getUuidCache
```
@Deprecated
@NonNull UuidCache getUuidCache()
```
    Deprecated. this feature is now handled internally - and the API returns a No-op implementation of this class.
    
    Gets a UuidCache.
    The uuid cache provides read access to the internal LuckPerms uuid mapping system.
    
    Returns:
    
    the uuid cache
  - getContextManager
```
@NonNull ContextManager getContextManager()
```
    Gets the ContextManager.
    The context manager manages ContextCalculators, and calculates applicable contexts for a given type.
    
    Returns:
    
    the context manager
    
    Since:
    
    4.0
  - getNodeFactory
```
@NonNull NodeFactory getNodeFactory()
```
    Gets the NodeFactory.
    The node factory provides methods for building Node instances.
    
    Returns:
    
    the node factory
  - getMetaStackFactory
```
@NonNull MetaStackFactory getMetaStackFactory()
```
    Gets the MetaStackFactory.
    The metastack factory provides methods for retrieving MetaStackElements and constructing MetaStackDefinitions.
    
    Returns:
    
    the meta stack factory
    
    Since:
    
    3.2
  - getUser
```
default @Nullable User getUser(@NonNull UUID uuid)
```
    Gets a wrapped user object from the user storage
    
    Parameters:
    
    uuid - the uuid of the user to get
    
    Returns:
    
    a User object, if one matching the uuid is loaded, or null if not
    
    Throws:
    
    NullPointerException - if the uuid is null
  - getUserSafe
```
default @NonNull Optional<User> getUserSafe(@NonNull UUID uuid)
```
    Gets a wrapped user object from the user storage.
    
    Parameters:
    
    uuid - the uuid of the user to get
    
    Returns:
    
    an optional User object
    
    Throws:
    
    NullPointerException - if the uuid is null
  - getUser
```
default @Nullable User getUser(@NonNull String name)
```
    Gets a wrapped user object from the user storage
    
    Parameters:
    
    name - the username of the user to get
    
    Returns:
    
    a User object, if one matching the uuid is loaded, or null if not
    
    Throws:
    
    NullPointerException - if the name is null
  - getUserSafe
```
default @NonNull Optional<User> getUserSafe(@NonNull String name)
```
    Gets a wrapped user object from the user storage.
    
    Parameters:
    
    name - the username of the user to get
    
    Returns:
    
    an optional User object
    
    Throws:
    
    NullPointerException - if the name is null
  - getUsers
```
default @NonNull Set<User> getUsers()
```
    Gets a set of all loaded users.
    
    Returns:
    
    a Set of User objects
  - isUserLoaded
```
default boolean isUserLoaded(@NonNull UUID uuid)
```
    Check if a user is loaded in memory
    
    Parameters:
    
    uuid - the uuid to check for
    
    Returns:
    
    true if the user is loaded
    
    Throws:
    
    NullPointerException - if the uuid is null
  - cleanupUser
```
default void cleanupUser(@NonNull User user)
```
    Unload a user from the internal storage, if they're not currently online.
    
    Parameters:
    
    user - the user to unload
    
    Throws:
    
    NullPointerException - if the user is null
  - getGroup
```
default @Nullable Group getGroup(@NonNull String name)
```
    Gets a wrapped group object from the group storage
    
    Parameters:
    
    name - the name of the group to get
    
    Returns:
    
    a Group object, if one matching the name exists, or null if not
    
    Throws:
    
    NullPointerException - if the name is null
  - getGroupSafe
```
default @NonNull Optional<Group> getGroupSafe(@NonNull String name)
```
    Gets a wrapped group object from the group storage.
    This method does not return null, unlike getGroup(java.lang.String)
    
    Parameters:
    
    name - the name of the group to get
    
    Returns:
    
    an optional Group object
    
    Throws:
    
    NullPointerException - if the name is null
  - getGroups
```
default @NonNull Set<Group> getGroups()
```
    Gets a set of all loaded groups.
    
    Returns:
    
    a Set of Group objects
  - isGroupLoaded
```
default boolean isGroupLoaded(@NonNull String name)
```
    Check if a group is loaded in memory
    
    Parameters:
    
    name - the name to check for
    
    Returns:
    
    true if the group is loaded
    
    Throws:
    
    NullPointerException - if the name is null
  - getTrack
```
default @Nullable Track getTrack(@NonNull String name)
```
    Gets a wrapped track object from the track storage
    
    Parameters:
    
    name - the name of the track to get
    
    Returns:
    
    a Track object, if one matching the name exists, or null if not
    
    Throws:
    
    NullPointerException - if the name is null
  - getTrackSafe
```
default @NonNull Optional<Track> getTrackSafe(@NonNull String name)
```
    Gets a wrapped track object from the track storage.
    This method does not return null, unlike getTrack(java.lang.String)
    
    Parameters:
    
    name - the name of the track to get
    
    Returns:
    
    an optional Track object
    
    Throws:
    
    NullPointerException - if the name is null
  - getTracks
```
default @NonNull Set<Track> getTracks()
```
    Gets a set of all loaded tracks.
    
    Returns:
    
    a Set of Track objects
  - isTrackLoaded
```
default boolean isTrackLoaded(@NonNull String name)
```
    Check if a track is loaded in memory
    
    Parameters:
    
    name - the name to check for
    
    Returns:
    
    true if the track is loaded
    
    Throws:
    
    NullPointerException - if the name is null
  - newLogEntryBuilder
```
default LogEntry.Builder newLogEntryBuilder()
```
    Returns a new LogEntry Builder instance
    
    Returns:
    
    a new builder
    
    Since:
    
    4.0
  - buildNode
```
default Node.Builder buildNode(@NonNull String permission)
                        throws IllegalArgumentException
```
    Returns a permission builder instance
    
    Parameters:
    
    permission - the main permission node to build
    
    Returns:
    
    a Node.Builder instance
    
    Throws:
    
    IllegalArgumentException - if the permission is invalid
    
    NullPointerException - if the permission is null
    
    Since:
    
    2.6
  - registerContextCalculator
```
default void registerContextCalculator(@NonNull ContextCalculator<?> calculator)
```
    Register a custom context calculator to the server
    
    Parameters:
    
    calculator - the context calculator to register. The type MUST be the player class of the platform.
    
    Throws:
    
    ClassCastException - if the type is not the player class of the platform.
  - getContextForUser
```
default @NonNull Optional<Contexts> getContextForUser(@NonNull User user)
```
    Gets a calculated context instance for the user using the rules of the platform.
    These values are calculated using the options in the configuration, and the provided calculators.
    
    Parameters:
    
    user - the user to get contexts for
    
    Returns:
    
    an optional containing contexts. Will return empty if the user is not online.
  - getContextForPlayer
```
default @NonNull ContextSet getContextForPlayer(@NonNull Object player)
```
    Gets set of contexts applicable to a player using the platforms ContextCalculators.
    
    Parameters:
    
    player - the player to calculate for. Must be the player instance for the platform.
    
    Returns:
    
    a set of contexts.
    
    Since:
    
    2.17
  - getContextsForPlayer
```
default @NonNull Contexts getContextsForPlayer(@NonNull Object player)
```
    Gets a Contexts instance for the player using the platforms ContextCalculators.
    
    Parameters:
    
    player - the player to calculate for. Must be the player instance for the platform.
    
    Returns:
    
    a set of contexts.
    
    Since:
    
    3.3

Interface LuckPermsApi

Method Summary

Method Detail

getPlatformInfo

getUserManager

getGroupManager

getTrackManager

runUpdateTask

getEventBus

getConfiguration

getStorage

getMessagingService

registerMessengerProvider

getActionLogger

getUuidCache

getContextManager

getNodeFactory

getMetaStackFactory

getUser

getUserSafe

getUser

getUserSafe

getUsers

isUserLoaded

cleanupUser

getGroup

getGroupSafe

getGroups

isGroupLoaded

getTrack

getTrackSafe

getTracks

isTrackLoaded

newLogEntryBuilder

buildNode

registerContextCalculator

getContextForUser

getContextForPlayer

getContextsForPlayer