Interface TicketService

public interface TicketService

Player support tickets: create, reply, claim, close - and a transcript on closure.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	TicketService.ClaimResult
static enum	TicketService.CloseResult
static enum	TicketService.ReplyResult

Method Summary

Modifier and Type	Method	Description
List<String>	categories()	Configured categories, in order; empty if the module has none set up.
CompletableFuture<TicketService.ClaimResult>	claim(long ticketId, UUID staff, String staffUsername)
CompletableFuture<TicketService.CloseResult>	close(long ticketId, UUID closedBy, String closedByUsername)	Closes the ticket and writes its full transcript to plugins/YouNeedMe/tickets/ - the returned result's TicketService.CloseResult.SUCCESS carries no transcript path since the write happens after the DB update; callers wanting the path should follow up with messages(long).
CompletableFuture<Ticket>	create(UUID player, String playerUsername, @Nullable String category, String message)
CompletableFuture<Optional<Ticket>>	find(long id)
CompletableFuture<List<Ticket>>	history(UUID player)	A player's closed tickets, most recent first.
CompletableFuture<List<Ticket>>	listOpen()	Every ticket not yet closed (OPEN or CLAIMED), oldest first - the staff queue.
CompletableFuture<List<TicketMessage>>	messages(long ticketId)
CompletableFuture<List<Ticket>>	openByPlayer(UUID player)	A player's own not-yet-closed tickets.
CompletableFuture<TicketService.ReplyResult>	reply(long ticketId, UUID author, String authorUsername, String message, boolean staffMessage)

Method Details

categories

List<String> categories()

Configured categories, in order; empty if the module has none set up.

create

CompletableFuture<Ticket> create(UUID player,
 String playerUsername,
 @Nullable
 @Nullable String category,
 String message)

find

CompletableFuture<Optional<Ticket>> find(long id)

listOpen

CompletableFuture<List<Ticket>> listOpen()

Every ticket not yet closed (OPEN or CLAIMED), oldest first - the staff queue.

openByPlayer

CompletableFuture<List<Ticket>> openByPlayer(UUID player)

A player's own not-yet-closed tickets.

history

CompletableFuture<List<Ticket>> history(UUID player)

A player's closed tickets, most recent first.

messages

CompletableFuture<List<TicketMessage>> messages(long ticketId)

claim

CompletableFuture<TicketService.ClaimResult> claim(long ticketId,
 UUID staff,
 String staffUsername)

reply

CompletableFuture<TicketService.ReplyResult> reply(long ticketId,
 UUID author,
 String authorUsername,
 String message,
 boolean staffMessage)

close

CompletableFuture<TicketService.CloseResult> close(long ticketId,
 UUID closedBy,
 String closedByUsername)

Closes the ticket and writes its full transcript to plugins/YouNeedMe/tickets/ - the returned result's TicketService.CloseResult.SUCCESS carries no transcript path since the write happens after the DB update; callers wanting the path should follow up with messages(long).