Package nl.martenm.surveyplus.api.models

Interface ISurveyMeta

All Known Subinterfaces:
ISurvey
public interface ISurveyMeta
The SurveyMeta holds all the basic information about a survey. This is used to display it to users without having to get all additional information like questions.

  • Method Details

    • getId

      int getId()
      Gets the internal ID for this survey.
      Returns:
      The internal ID

    • getName

      String getName()
      Gets the display name of this survey.
      Returns:
      The display name

    • getDescription

      String getDescription()
      Gets the description for this survey.
      Returns:
      The description

    • isFeatured

      boolean isFeatured()
      Gets if this survey is being featured right now.
      Returns:
      True if featured

    • isAvailable

      boolean isAvailable()
      Gets if this survey is being featured currently.
      Returns:
      True if the survey is featured.

    • getType

      String getType()
      Gets the survey type. The type is used to determine the UI.
      Returns:
      The survey type as string

    • getRewards

      List<String> getRewards()
      Get a list of all rewards. These can be fed to the RewardsManager to properly reward a player.
      Returns:
      The rewards

    • requiresPermission

      boolean requiresPermission()
      Gets if this survey requires additional permissions.
      Returns:
      True if permissions are required.

    • getPermissionString

      String getPermissionString()

    • getTargetServer

      String getTargetServer()
      Gets the target server group name of this survey. The survey will only be featured on server that match this name.
      Returns:
      The target as String.