platform-paper/dev.m1sk9.lunaticChat.paper.chat.channel/ChannelManager

ChannelManager

class ChannelManager(storage: ChannelStorage, logger: Logger, config: ChannelChatFeatureConfig) : StoppableService(source)

Constructors

constructor(storage: ChannelStorage, logger: Logger, config: ChannelChatFeatureConfig)

Functions

fun addMember(channelId: String, playerId: UUID, role: ChannelRole): Result<Unit>

Adds a member to a channel.

fun banPlayer(channelId: String, playerId: UUID): Result<Channel>

Bans a player from a channel.

fun channelIdsOf(playerId: UUID): List<String>

Returns the ids of every existing channel the player belongs to.

fun createChannel(channel: Channel): Result<Channel>

Creates a new channel.

fun deleteChannel(channelId: String, requesterId: UUID, hasBypassPermission: Boolean = false): Result<Unit>

Deletes a channel.

fun getAllChannels(): Result<List<Channel>>

Retrieves all channels.

fun getChannel(channelId: String): Result<Channel>

Retrieves a channel by its ID.

getChannelMembers

fun getChannelMembers(channelId: String): Result<List<ChannelMember>>

Retrieves members of a channel.

getPlayerChannel

fun getPlayerChannel(playerId: UUID): String?

Gets the active channel of a player.

getPlayerChannelContext

fun getPlayerChannelContext(playerId: UUID): ChannelContext?

Gets the full channel context (channel and members) of a player's active channel.

getPublicChannels

fun getPublicChannels(): Result<List<Channel>>

Retrieves all public channels.

fun initialize()

Initializes the ChannelManager by loading data from storage.

fun isMember(channelId: String, playerId: UUID): Result<Boolean>

Answers whether a player belongs to a channel without handing out the member list.

fun isPlayerBanned(channelId: String, playerId: UUID): Result<Boolean>

Checks if a player is banned from a channel.

fun removeMember(channelId: String, playerId: UUID): Result<Unit>

Removes a member from a channel.

restorePlayerChannel

fun restorePlayerChannel(playerId: UUID): ChannelContext?

Restores the active channel of a player based on their channel membership. If the player is a member of multiple channels, the most recently joined one is selected.

fun saveToDisk()

setPlayerChannel

fun setPlayerChannel(playerId: UUID, channelId: String?)

Sets the active channel of a player.

open override fun stop()

Saves the current state of channels and members to storage synchronously. Should only br called during server shutdown.

fun unbanPlayer(channelId: String, playerId: UUID): Result<Channel>

Unbans a player from a channel.

updateChannelOwner

fun updateChannelOwner(channelId: String, newOwnerId: UUID): Result<Channel>

Updates the channel owner.

updateMemberRole

fun updateMemberRole(channelId: String, playerId: UUID, newRole: ChannelRole): Result<Unit>

Updates a member's role in a channel.