Interface NotesApi

public interface NotesApi

Manages notes attached to Plex players.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	add(UUID player, String content, @Nullable UUID author)	Adds a note to a player.
CompletableFuture<Integer>	clear(UUID player)	Removes every note from a player.
CompletableFuture<List<PlayerNote>>	list(UUID player)	Returns a player's notes in ID order.
CompletableFuture<Boolean>	remove(UUID player, int id)	Removes a note from a player.

Method Details

list

CompletableFuture<List<PlayerNote>> list(UUID player)

Returns a player's notes in ID order.

Parameters:

player - player UUID

Returns:

future containing the player's notes

add

CompletableFuture<Void> add(UUID player,
 String content,
 @Nullable
 @Nullable UUID author)

Adds a note to a player.

Parameters:

player - player UUID

content - note content

author - author UUID, or null for console

Returns:

future completed after the note is stored

remove

CompletableFuture<Boolean> remove(UUID player,
 int id)

Removes a note from a player.

Parameters:

player - player UUID

id - player-local note ID

Returns:

future containing whether the note existed

clear

CompletableFuture<Integer> clear(UUID player)

Removes every note from a player.

Parameters:

player - player UUID

Returns:

future containing the number of removed notes