Package ovh.mythmc.social.api.user

Interface SocialUserService

All Known Implementing Classes:

BukkitSocialUserService

public interface SocialUserService

Represents a class capable of holding all SocialUsers present in the server.

Method Summary

Modifier and Type	Method	Description
@NotNull Set<SocialUser>	get()	Gets all current SocialUsers in this server
@NotNull Optional<SocialUser>	getByUuid(@NotNull UUID uuid)	Gets a specific SocialUser by its UUID.
@NotNull SocialUser	getOrCreate(@NotNull UUID uuid)	Gets a specific SocialUser by its UUID.
default Collection<SocialUser>	getSocialSpyUsers()	Gets all SocialUsers with the spy feature on.
default Collection<SocialUser>	getSocialSpyUsersInChannel(@NotNull SimpleChatChannel channel)	Gets all SocialUsers with the spy feature on in a specific SimpleChatChannel.
@NotNull IdentityResolver	identityResolver()	Gets the IdentityResolver of this server

Method Details

identityResolver

@NotNull
@NotNull IdentityResolver identityResolver()

Gets the IdentityResolver of this server

Returns:

the IdentityResolver of this server

get

@NotNull
@NotNull Set<SocialUser> get()

Gets all current SocialUsers in this server

Returns:

a Set with every SocialUser in the server

getOrCreate

@NotNull
@NotNull SocialUser getOrCreate(@NotNull
 @NotNull UUID uuid)

Gets a specific SocialUser by its UUID.

If the SocialUser doesn't exist, it will be created by the service.

Parameters:

uuid - the UUID of the user

Returns:

a SocialUser matching the UUID

getByUuid

@NotNull
@NotNull Optional<SocialUser> getByUuid(@NotNull
 @NotNull UUID uuid)

Gets a specific SocialUser by its UUID.

Parameters:

uuid - the UUID of the user

Returns:

an Optional containing the SocialUser if present, or an empty Optional otherwise

getSocialSpyUsers

default Collection<SocialUser> getSocialSpyUsers()

Gets all SocialUsers with the spy feature on.

Returns:

a Collection with all SocialUsers with the spy feature on

getSocialSpyUsersInChannel

default Collection<SocialUser> getSocialSpyUsersInChannel(@NotNull
 @NotNull SimpleChatChannel channel)

Gets all SocialUsers with the spy feature on in a specific SimpleChatChannel.

Parameters:

channel - the SimpleChatChannel to get the users from

Returns:

a Collection with every SocialUser with the spy feature on in the SimpleChatChannel