PolarDocs Client Area

PolarApi Interface

Introduction#

The PolarApi interface serves as the entry point to access various components and functionalities within the Polar API. It provides methods to retrieve the Server object, register subcommands, access the UserRepository, and manage events through the Events class.

Methods#

The PolarApi interface provides the following methods:

server#

java
Server server();

Description:

This method retrieves the Server object, which provides access to server-related functionalities.

Returns:

The Server object.

subcommands#

java
Subcommands subcommands();

Description:

This method retrieves the Subcommands object, which allows registering custom /polar subcommands and adjusting the built-in ones.

Returns:

The Subcommands object.

userRepository#

java
UserRepository userRepository();

Description:

This method retrieves the UserRepository object, which provides methods to query user information.

Returns:

The UserRepository object.

events#

java
Events events();

Description:

This method accesses the event management class, Events, which facilitates event handling.

Returns:

The Events object.