Index (surveyplus-api 2.11.1 API)

A C E G H I M N O Q R S T V
All Classes and Interfaces|All Packages

A

addGeneric(GenericReward) - Method in interface nl.martenm.surveyplus.api.managers.IRewardsManager: Add a generic reward that can then be used as preset.
addHandler(String, SurveyUI) - Method in interface nl.martenm.surveyplus.api.managers.ISurveyUIManager: Add a survey UI handler.
Answer - Class in nl.martenm.surveyplus.api.models: Represents an answer to a question.
Answer(int, String) - Constructor for class nl.martenm.surveyplus.api.models.Answer
attemptFeaturedSurvey(UUID) - Method in interface nl.martenm.surveyplus.api.managers.ISurveyManager: Shows the featured survey to the player (if there are any).
attemptFeaturedSurvey(UUID, int) - Method in interface nl.martenm.surveyplus.api.managers.ISurveyManager: Attempts to show a featured survey for a player.
attemptStart(UUID, int, Consumer<StartResult>) - Method in interface nl.martenm.surveyplus.api.managers.ISurveySessionManager: Attempts to start a survey for the target player.

C

cancelSession(UUID) - Method in interface nl.martenm.surveyplus.api.managers.ISurveySessionManager: Cancel a players survey session.
cancelSessions() - Method in interface nl.martenm.surveyplus.api.managers.ISurveySessionManager: Cancels all sessions that are currently being executed.
cancelSessions(int) - Method in interface nl.martenm.surveyplus.api.managers.ISurveySessionManager: Cancels the session of a particular survey.
checkConditions(ISurveySession) - Method in interface nl.martenm.surveyplus.api.models.questions.ISurveyQuestion: Checks all the conditions.
CLOSED - Enum constant in enum nl.martenm.surveyplus.api.models.questions.QuestionType

E

ERROR_ALREADY_COMPLETED - Enum constant in enum nl.martenm.surveyplus.api.models.StartResult: Survey has already been completed by the user.
ERROR_ALREADY_IN_A_SESSION - Enum constant in enum nl.martenm.surveyplus.api.models.StartResult: User already has a survey session going.
ERROR_DATABASE - Enum constant in enum nl.martenm.surveyplus.api.models.StartResult: A database error occurred when attempting to start the survey.
ERROR_NO_PERMISSION - Enum constant in enum nl.martenm.surveyplus.api.models.StartResult: User has no permission to start the survey.
ERROR_NO_QUESTIONS - Enum constant in enum nl.martenm.surveyplus.api.models.StartResult: Survey error: The survey has no questions.
ERROR_NOT_AVAILABLE - Enum constant in enum nl.martenm.surveyplus.api.models.StartResult: Survey is not available.
ERROR_UNKNOWN_ID - Enum constant in enum nl.martenm.surveyplus.api.models.StartResult: Attempting to start a survey with an unknown id.
execute(Player, String) - Method in class nl.martenm.surveyplus.api.models.rewards.GenericReward

G

GenericReward - Class in nl.martenm.surveyplus.api.models.rewards: This is the base class for al preset commands.
GenericReward(String) - Constructor for class nl.martenm.surveyplus.api.models.rewards.GenericReward
getAnswer() - Method in class nl.martenm.surveyplus.api.events.SurveyAnswerEvent
getAnswer() - Method in class nl.martenm.surveyplus.api.models.Answer
getAnswers() - Method in class nl.martenm.surveyplus.api.events.SurveyQuestionFinishedEvent
getAnswers() - Method in interface nl.martenm.surveyplus.api.models.ISurveySession: Gets a list of all answers given in this session.
getAvailableSurveysMeta(UUID, Consumer<List<ISurveyMeta>>) - Method in interface nl.martenm.surveyplus.api.managers.ISurveyManager
getConditions() - Method in interface nl.martenm.surveyplus.api.models.questions.ISurveyQuestion: The list of all conditions of this question.
getCurrentAnswers() - Method in interface nl.martenm.surveyplus.api.models.ISurveySession: Gives the answers that have been given for the current question.
getCurrentQuestion() - Method in interface nl.martenm.surveyplus.api.models.ISurveySession: Gets the current question the survey is currently on.
getDescription() - Method in interface nl.martenm.surveyplus.api.models.ISurveyMeta: Gets the description for this survey.
getDescription() - Method in class nl.martenm.surveyplus.api.models.rewards.GenericReward
getDescription() - Method in class nl.martenm.surveyplus.api.models.SurveyDefaults
getExample() - Method in class nl.martenm.surveyplus.api.models.rewards.GenericReward
getGenerics() - Method in interface nl.martenm.surveyplus.api.managers.IRewardsManager: A list of all generic rewards.
getHandler(String) - Method in interface nl.martenm.surveyplus.api.managers.ISurveyUIManager: Gets the SurveyUI handler for a particular type.
getHandlerList() - Static method in class nl.martenm.surveyplus.api.events.SurveyAnswerEvent
getHandlerList() - Static method in class nl.martenm.surveyplus.api.events.SurveyFeatureEvent
getHandlerList() - Static method in class nl.martenm.surveyplus.api.events.SurveyFinishedEvent
getHandlerList() - Static method in class nl.martenm.surveyplus.api.events.SurveyNextQuestionEvent
getHandlerList() - Static method in class nl.martenm.surveyplus.api.events.SurveyQuestionFinishedEvent
getHandlerList() - Static method in class nl.martenm.surveyplus.api.events.SurveyStartEvent
getHandlers() - Method in class nl.martenm.surveyplus.api.events.SurveyAnswerEvent
getHandlers() - Method in class nl.martenm.surveyplus.api.events.SurveyFeatureEvent
getHandlers() - Method in class nl.martenm.surveyplus.api.events.SurveyFinishedEvent
getHandlers() - Method in class nl.martenm.surveyplus.api.events.SurveyNextQuestionEvent
getHandlers() - Method in class nl.martenm.surveyplus.api.events.SurveyQuestionFinishedEvent
getHandlers() - Method in class nl.martenm.surveyplus.api.events.SurveyStartEvent
getId() - Method in interface nl.martenm.surveyplus.api.models.ISurveyMeta: Gets the internal ID for this survey.
getId() - Method in interface nl.martenm.surveyplus.api.models.questions.ISurveyQuestion: The internal ID of this question.
getIdentifier() - Method in class nl.martenm.surveyplus.api.models.rewards.GenericReward
getIdentifierLong() - Method in class nl.martenm.surveyplus.api.models.rewards.GenericReward
getIdleTimeInSeconds() - Method in interface nl.martenm.surveyplus.api.models.ISurveySession: Gets the time in seconds from the last interaction with this survey session.
getKey() - Method in enum nl.martenm.surveyplus.api.models.questions.QuestionType
getLastReminderSeconds() - Method in interface nl.martenm.surveyplus.api.models.ISurveySession: Gets the time since the last reminder was sent.
getMeta() - Method in class nl.martenm.surveyplus.api.events.SurveyFeatureEvent
getName() - Method in interface nl.martenm.surveyplus.api.models.ISurveyMeta: Gets the display name of this survey.
getName() - Method in class nl.martenm.surveyplus.api.models.SurveyDefaults
getNext(QuestionType) - Static method in enum nl.martenm.surveyplus.api.models.questions.QuestionType
getOptions() - Method in interface nl.martenm.surveyplus.api.models.questions.ISurveyQuestion: Gets the options to a question.
getPermissionString() - Method in interface nl.martenm.surveyplus.api.models.ISurveyMeta
getPlayerUUID() - Method in interface nl.martenm.surveyplus.api.models.ISurveySession: Gets the UUID of the player answering that this session belongs to.
getQuestion() - Method in class nl.martenm.surveyplus.api.events.SurveyQuestionFinishedEvent
getQuestion() - Method in interface nl.martenm.surveyplus.api.models.questions.ISurveyQuestion: Gets the question text.
getQuestionId() - Method in class nl.martenm.surveyplus.api.models.Answer
getRewards() - Method in interface nl.martenm.surveyplus.api.models.ISurveyMeta: Get a list of all rewards.
getRewards() - Method in class nl.martenm.surveyplus.api.models.SurveyDefaults
getRewardsManager() - Method in interface nl.martenm.surveyplus.api.SurveyPlusAPI: Gets the reward manager
getSession() - Method in class nl.martenm.surveyplus.api.events.SurveyAnswerEvent
getSession() - Method in class nl.martenm.surveyplus.api.events.SurveyFinishedEvent
getSession() - Method in class nl.martenm.surveyplus.api.events.SurveyNextQuestionEvent
getSession() - Method in class nl.martenm.surveyplus.api.events.SurveyStartEvent
getSurvey() - Method in interface nl.martenm.surveyplus.api.models.ISurveySession: Gets the survey this session is for.
getSurveyId() - Method in interface nl.martenm.surveyplus.api.models.questions.ISurveyQuestion: Gets the survey ID that this question belongs to.
getSurveyManager() - Method in interface nl.martenm.surveyplus.api.SurveyPlusAPI: Gets the survey manager
getSurveySessionManager() - Method in interface nl.martenm.surveyplus.api.SurveyPlusAPI: Gets the survey session manager
getSurveyUIManager() - Method in interface nl.martenm.surveyplus.api.SurveyPlusAPI: Gets the survey UI manager
getTargetServer() - Method in interface nl.martenm.surveyplus.api.models.ISurveyMeta: Gets the target server group name of this survey.
getType() - Method in interface nl.martenm.surveyplus.api.models.ISurveyMeta: Gets the survey type.
getType() - Method in interface nl.martenm.surveyplus.api.models.questions.ISurveyQuestion: Gets the type of this question
getTypes() - Method in interface nl.martenm.surveyplus.api.managers.ISurveyUIManager: Gets a collection of all types that have currently been registered.
getUsage() - Method in class nl.martenm.surveyplus.api.models.rewards.GenericReward
getUser() - Method in class nl.martenm.surveyplus.api.events.SurveyFeatureEvent
getWeight() - Method in interface nl.martenm.surveyplus.api.models.questions.ISurveyQuestion: The weight of this question.

H

handleResponse(UUID, String) - Method in interface nl.martenm.surveyplus.api.managers.ISurveySessionManager: Handles the response.
hasDescription() - Method in class nl.martenm.surveyplus.api.models.rewards.GenericReward
hasExample() - Method in class nl.martenm.surveyplus.api.models.rewards.GenericReward
hasFinished() - Method in interface nl.martenm.surveyplus.api.models.ISurveySession: Checks if all questions have been answered.
hasOptions() - Method in interface nl.martenm.surveyplus.api.models.questions.ISurveyQuestion: If this survey question has options available.
hasReceivedReminder() - Method in interface nl.martenm.surveyplus.api.models.ISurveySession: If this player has received a reminder.
hasSession(UUID) - Method in interface nl.martenm.surveyplus.api.managers.ISurveySessionManager: Check if the uuid has a survey session.

I

IRewardsManager - Interface in nl.martenm.surveyplus.api.managers: The rewards manager handles all rewards and reward presets.
isAvailable() - Method in interface nl.martenm.surveyplus.api.models.ISurveyMeta: Gets if this survey is being featured currently.
isCancelled() - Method in class nl.martenm.surveyplus.api.events.SurveyFeatureEvent
isCancelled() - Method in class nl.martenm.surveyplus.api.events.SurveyStartEvent
isFeatured() - Method in interface nl.martenm.surveyplus.api.models.ISurveyMeta: Gets if this survey is being featured right now.
isGenericReward(String) - Method in interface nl.martenm.surveyplus.api.managers.IRewardsManager: Checks if a string is present as generic reward.
isPreviewMode() - Method in interface nl.martenm.surveyplus.api.models.ISurveySession: Gets if this survey is currently in preview mode or not
isSaved() - Method in interface nl.martenm.surveyplus.api.models.ISurveySession: Gets if the response has been saved to the database.
ISurvey - Interface in nl.martenm.surveyplus.api.models
ISurveyManager - Interface in nl.martenm.surveyplus.api.managers: The survey manager manages surveys.
ISurveyMeta - Interface in nl.martenm.surveyplus.api.models: The SurveyMeta holds all the basic information about a survey.
ISurveyQuestion - Interface in nl.martenm.surveyplus.api.models.questions: The interface that represents a survey question.
ISurveySession - Interface in nl.martenm.surveyplus.api.models
ISurveySessionManager - Interface in nl.martenm.surveyplus.api.managers: This manager class manages all survey sessions.
ISurveyUIManager - Interface in nl.martenm.surveyplus.api.managers: Manages all SurveyUI entries.

M

matchIdentifier(String) - Method in class nl.martenm.surveyplus.api.models.rewards.GenericReward
MULTIPLE - Enum constant in enum nl.martenm.surveyplus.api.models.questions.QuestionType

N

nextQuestion() - Method in interface nl.martenm.surveyplus.api.models.ISurveySession: Moves the index to the next question.
nl.martenm.surveyplus.api - package nl.martenm.surveyplus.api
nl.martenm.surveyplus.api.events - package nl.martenm.surveyplus.api.events
nl.martenm.surveyplus.api.interfaces - package nl.martenm.surveyplus.api.interfaces
nl.martenm.surveyplus.api.managers - package nl.martenm.surveyplus.api.managers
nl.martenm.surveyplus.api.models - package nl.martenm.surveyplus.api.models
nl.martenm.surveyplus.api.models.questions - package nl.martenm.surveyplus.api.models.questions
nl.martenm.surveyplus.api.models.rewards - package nl.martenm.surveyplus.api.models.rewards

O

OPEN - Enum constant in enum nl.martenm.surveyplus.api.models.questions.QuestionType

Q

QuestionType - Enum in nl.martenm.surveyplus.api.models.questions: An enum that holds every question type.

R

requiresPermission() - Method in interface nl.martenm.surveyplus.api.models.ISurveyMeta: Gets if this survey requires additional permissions.
rewardPlayer(Player, List<String>) - Method in interface nl.martenm.surveyplus.api.managers.IRewardsManager: Reward a player.

S

SELECT - Enum constant in enum nl.martenm.surveyplus.api.models.questions.QuestionType
serializeRewards() - Method in class nl.martenm.surveyplus.api.models.SurveyDefaults
setAnswer(String) - Method in class nl.martenm.surveyplus.api.events.SurveyAnswerEvent
setCancelled(boolean) - Method in class nl.martenm.surveyplus.api.events.SurveyFeatureEvent
setCancelled(boolean) - Method in class nl.martenm.surveyplus.api.events.SurveyStartEvent
setDescription(String) - Method in class nl.martenm.surveyplus.api.models.rewards.GenericReward
setExample(String) - Method in class nl.martenm.surveyplus.api.models.rewards.GenericReward: Sets the example string of this reward.
setUsage(String) - Method in class nl.martenm.surveyplus.api.models.rewards.GenericReward
showFinished(Player, ISurveySession) - Method in interface nl.martenm.surveyplus.api.interfaces.SurveyUI: Show a finish screen that displays that the survey has been completed successfully.
showQuestion(UUID) - Method in interface nl.martenm.surveyplus.api.managers.ISurveySessionManager: Show the current question to the user.
showQuestion(Player, ISurveySession) - Method in interface nl.martenm.surveyplus.api.interfaces.SurveyUI: Should show an UI that displays the current question together with an option to answer.
showSurveyFeatured(Player, ISurveyMeta) - Method in interface nl.martenm.surveyplus.api.interfaces.SurveyUI: Shows some very basic information about the survey.
sortQuestions() - Method in interface nl.martenm.surveyplus.api.models.ISurvey: Sorts the questions by weight.
StartResult - Enum in nl.martenm.surveyplus.api.models: The start can be returned when attempting to start a survey.
startSession(UUID, int, boolean) - Method in interface nl.martenm.surveyplus.api.managers.ISurveySessionManager: Will grab the survey async and attempt to start a session.
startSession(UUID, int, boolean, Consumer<StartResult>) - Method in interface nl.martenm.surveyplus.api.managers.ISurveySessionManager: Will grab the survey async and attempt to start a session.
SUCCESS - Enum constant in enum nl.martenm.surveyplus.api.models.StartResult: Survey started
SurveyAnswerEvent - Class in nl.martenm.surveyplus.api.events: Event called when an user submits a valid answer for a question.
SurveyAnswerEvent(ISurveySession, String) - Constructor for class nl.martenm.surveyplus.api.events.SurveyAnswerEvent
SurveyDefaults - Class in nl.martenm.surveyplus.api.models: Defaults for a newly created survey.
SurveyDefaults(String, String, String) - Constructor for class nl.martenm.surveyplus.api.models.SurveyDefaults
SurveyDefaults(String, String, List<String>) - Constructor for class nl.martenm.surveyplus.api.models.SurveyDefaults
SurveyFeatureEvent - Class in nl.martenm.surveyplus.api.events: Event called when a featured survey is about to be shown to an user.
SurveyFeatureEvent(UUID, ISurveyMeta) - Constructor for class nl.martenm.surveyplus.api.events.SurveyFeatureEvent
SurveyFinishedEvent - Class in nl.martenm.surveyplus.api.events: Event called when a user finishes a survey.
SurveyFinishedEvent(ISurveySession) - Constructor for class nl.martenm.surveyplus.api.events.SurveyFinishedEvent
SurveyNextQuestionEvent - Class in nl.martenm.surveyplus.api.events: Event called when the survey moves to the next question.
SurveyNextQuestionEvent(ISurveySession) - Constructor for class nl.martenm.surveyplus.api.events.SurveyNextQuestionEvent
SurveyPlusAPI - Interface in nl.martenm.surveyplus.api: The SurveyPlusAPI is the entry point for using the API.
SurveyQuestionFinishedEvent - Class in nl.martenm.surveyplus.api.events: Event fired once the survey question has been finished and the user has moved on to the next question.
SurveyQuestionFinishedEvent(ISurveySession, ISurveyQuestion, List<String>) - Constructor for class nl.martenm.surveyplus.api.events.SurveyQuestionFinishedEvent
SurveyStartEvent - Class in nl.martenm.surveyplus.api.events: Event called when a new survey is started.
SurveyStartEvent(ISurveySession) - Constructor for class nl.martenm.surveyplus.api.events.SurveyStartEvent
SurveyUI - Interface in nl.martenm.surveyplus.api.interfaces: The interface used to create UI for surveys.

T

toString() - Method in enum nl.martenm.surveyplus.api.models.questions.QuestionType

V

valueOf(String) - Static method in enum nl.martenm.surveyplus.api.models.questions.QuestionType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum nl.martenm.surveyplus.api.models.StartResult: Returns the enum constant of this type with the specified name.
values() - Static method in enum nl.martenm.surveyplus.api.models.questions.QuestionType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum nl.martenm.surveyplus.api.models.StartResult: Returns an array containing the constants of this enum type, in the order they are declared.

A C E G H I M N O Q R S T V
All Classes and Interfaces|All Packages