Record Class SendPoll

java.lang.Object
java.lang.Record
org.teleight.teleightbots.api.methods.SendPoll
All Implemented Interfaces:
ApiMethod<Message>, MultiPartApiMethod<Message>, MultiPartApiMethodMessage
public record SendPoll(@Nullable String businessConnectionId, @NotNull String chatId, int messageThreadId, @NotNull String question, @Nullable ParseMode questionParseMode, @Nullable MessageEntity[] questionEntities, @NotNull InputPollOption[] options, boolean isAnonymous, @Nullable PollType type, boolean allowsMultipleAnswers, boolean allowsRevoting, boolean shuffleOptions, boolean allowAddingOptions, boolean hideResultsUntilCloses, boolean membersOnly, @Nullable String[] countryCodes, int[] correctOptionIds, @Nullable String explanation, @Nullable ParseMode explanationParseMode, @Nullable MessageEntity[] explanationEntities, @Nullable InputPollMedia explanationMedia, int openPeriod, long closeDate, boolean isClosed, @Nullable String description, @Nullable ParseMode descriptionParseMode, @Nullable MessageEntity[] descriptionEntities, @Nullable InputPollMedia media, boolean disableNotification, boolean protectContent, boolean allowPaidBroadcast, String messageEffectId, @Nullable ReplyParameters replyParameters, @Nullable ReplyKeyboard replyMarkup) extends Record implements MultiPartApiMethodMessage

  • Constructor Details

    • SendPoll

      public SendPoll(@Nullable @Nullable String businessConnectionId, @NotNull @NotNull String chatId, int messageThreadId, @NotNull @NotNull String question, @Nullable @Nullable ParseMode questionParseMode, @Nullable @Nullable MessageEntity[] questionEntities, @NotNull @NotNull InputPollOption[] options, boolean isAnonymous, @Nullable @Nullable PollType type, boolean allowsMultipleAnswers, boolean allowsRevoting, boolean shuffleOptions, boolean allowAddingOptions, boolean hideResultsUntilCloses, boolean membersOnly, @Nullable @Nullable String[] countryCodes, int[] correctOptionIds, @Nullable @Nullable String explanation, @Nullable @Nullable ParseMode explanationParseMode, @Nullable @Nullable MessageEntity[] explanationEntities, @Nullable @Nullable InputPollMedia explanationMedia, int openPeriod, long closeDate, boolean isClosed, @Nullable @Nullable String description, @Nullable @Nullable ParseMode descriptionParseMode, @Nullable @Nullable MessageEntity[] descriptionEntities, @Nullable @Nullable InputPollMedia media, boolean disableNotification, boolean protectContent, boolean allowPaidBroadcast, String messageEffectId, @Nullable @Nullable ReplyParameters replyParameters, @Nullable @Nullable ReplyKeyboard replyMarkup)
      Creates an instance of a SendPoll record class.
      Parameters:
      businessConnectionId - the value for the businessConnectionId record component
      chatId - the value for the chatId record component
      messageThreadId - the value for the messageThreadId record component
      question - the value for the question record component
      questionParseMode - the value for the questionParseMode record component
      questionEntities - the value for the questionEntities record component
      options - the value for the options record component
      isAnonymous - the value for the isAnonymous record component
      type - the value for the type record component
      allowsMultipleAnswers - the value for the allowsMultipleAnswers record component
      allowsRevoting - the value for the allowsRevoting record component
      shuffleOptions - the value for the shuffleOptions record component
      allowAddingOptions - the value for the allowAddingOptions record component
      hideResultsUntilCloses - the value for the hideResultsUntilCloses record component
      membersOnly - the value for the membersOnly record component
      countryCodes - the value for the countryCodes record component
      correctOptionIds - the value for the correctOptionIds record component
      explanation - the value for the explanation record component
      explanationParseMode - the value for the explanationParseMode record component
      explanationEntities - the value for the explanationEntities record component
      explanationMedia - the value for the explanationMedia record component
      openPeriod - the value for the openPeriod record component
      closeDate - the value for the closeDate record component
      isClosed - the value for the isClosed record component
      description - the value for the description record component
      descriptionParseMode - the value for the descriptionParseMode record component
      descriptionEntities - the value for the descriptionEntities record component
      media - the value for the media record component
      disableNotification - the value for the disableNotification record component
      protectContent - the value for the protectContent record component
      allowPaidBroadcast - the value for the allowPaidBroadcast record component
      messageEffectId - the value for the messageEffectId record component
      replyParameters - the value for the replyParameters record component
      replyMarkup - the value for the replyMarkup record component

  • Method Details

    • ofBuilder

      @NotNull public static @NotNull SendPoll.Builder ofBuilder(String chatId, String question, InputPollOption[] options)

    • getEndpointURL

      @NotNull public @NotNull String getEndpointURL()
      Description copied from interface: ApiMethod
      Returns the endpoint URL for the Telegram Bot API method.
      Specified by:
      getEndpointURL in interface ApiMethod<Message>
      Returns:
      the endpoint URL

    • getParameters

      @NotNull public @NotNull Map<String,Object> getParameters()
      Description copied from interface: MultiPartApiMethod
      Gets the parameters of the multipart API method.
      Specified by:
      getParameters in interface MultiPartApiMethod<Message>
      Returns:
      a map containing the parameters of the multipart API method

    • toBuilder

      public SendPoll.Builder toBuilder()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • businessConnectionId

      @Nullable public @Nullable String businessConnectionId()
      Returns the value of the businessConnectionId record component.
      Returns:
      the value of the businessConnectionId record component

    • chatId

      @NotNull public @NotNull String chatId()
      Returns the value of the chatId record component.
      Returns:
      the value of the chatId record component

    • messageThreadId

      public int messageThreadId()
      Returns the value of the messageThreadId record component.
      Returns:
      the value of the messageThreadId record component

    • question

      @NotNull public @NotNull String question()
      Returns the value of the question record component.
      Returns:
      the value of the question record component

    • questionParseMode

      @Nullable public @Nullable ParseMode questionParseMode()
      Returns the value of the questionParseMode record component.
      Returns:
      the value of the questionParseMode record component

    • questionEntities

      @Nullable public @Nullable MessageEntity[] questionEntities()
      Returns the value of the questionEntities record component.
      Returns:
      the value of the questionEntities record component

    • options

      @NotNull public @NotNull InputPollOption[] options()
      Returns the value of the options record component.
      Returns:
      the value of the options record component

    • isAnonymous

      public boolean isAnonymous()
      Returns the value of the isAnonymous record component.
      Returns:
      the value of the isAnonymous record component

    • type

      @Nullable public @Nullable PollType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • allowsMultipleAnswers

      public boolean allowsMultipleAnswers()
      Returns the value of the allowsMultipleAnswers record component.
      Returns:
      the value of the allowsMultipleAnswers record component

    • allowsRevoting

      public boolean allowsRevoting()
      Returns the value of the allowsRevoting record component.
      Returns:
      the value of the allowsRevoting record component

    • shuffleOptions

      public boolean shuffleOptions()
      Returns the value of the shuffleOptions record component.
      Returns:
      the value of the shuffleOptions record component

    • allowAddingOptions

      public boolean allowAddingOptions()
      Returns the value of the allowAddingOptions record component.
      Returns:
      the value of the allowAddingOptions record component

    • hideResultsUntilCloses

      public boolean hideResultsUntilCloses()
      Returns the value of the hideResultsUntilCloses record component.
      Returns:
      the value of the hideResultsUntilCloses record component

    • membersOnly

      public boolean membersOnly()
      Returns the value of the membersOnly record component.
      Returns:
      the value of the membersOnly record component

    • countryCodes

      @Nullable public @Nullable String[] countryCodes()
      Returns the value of the countryCodes record component.
      Returns:
      the value of the countryCodes record component

    • correctOptionIds

      public int[] correctOptionIds()
      Returns the value of the correctOptionIds record component.
      Returns:
      the value of the correctOptionIds record component

    • explanation

      @Nullable public @Nullable String explanation()
      Returns the value of the explanation record component.
      Returns:
      the value of the explanation record component

    • explanationParseMode

      @Nullable public @Nullable ParseMode explanationParseMode()
      Returns the value of the explanationParseMode record component.
      Returns:
      the value of the explanationParseMode record component

    • explanationEntities

      @Nullable public @Nullable MessageEntity[] explanationEntities()
      Returns the value of the explanationEntities record component.
      Returns:
      the value of the explanationEntities record component

    • explanationMedia

      @Nullable public @Nullable InputPollMedia explanationMedia()
      Returns the value of the explanationMedia record component.
      Returns:
      the value of the explanationMedia record component

    • openPeriod

      public int openPeriod()
      Returns the value of the openPeriod record component.
      Returns:
      the value of the openPeriod record component

    • closeDate

      public long closeDate()
      Returns the value of the closeDate record component.
      Returns:
      the value of the closeDate record component

    • isClosed

      public boolean isClosed()
      Returns the value of the isClosed record component.
      Returns:
      the value of the isClosed record component

    • description

      @Nullable public @Nullable String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • descriptionParseMode

      @Nullable public @Nullable ParseMode descriptionParseMode()
      Returns the value of the descriptionParseMode record component.
      Returns:
      the value of the descriptionParseMode record component

    • descriptionEntities

      @Nullable public @Nullable MessageEntity[] descriptionEntities()
      Returns the value of the descriptionEntities record component.
      Returns:
      the value of the descriptionEntities record component

    • media

      @Nullable public @Nullable InputPollMedia media()
      Returns the value of the media record component.
      Returns:
      the value of the media record component

    • disableNotification

      public boolean disableNotification()
      Returns the value of the disableNotification record component.
      Returns:
      the value of the disableNotification record component

    • protectContent

      public boolean protectContent()
      Returns the value of the protectContent record component.
      Returns:
      the value of the protectContent record component

    • allowPaidBroadcast

      public boolean allowPaidBroadcast()
      Returns the value of the allowPaidBroadcast record component.
      Returns:
      the value of the allowPaidBroadcast record component

    • messageEffectId

      public String messageEffectId()
      Returns the value of the messageEffectId record component.
      Returns:
      the value of the messageEffectId record component

    • replyParameters

      @Nullable public @Nullable ReplyParameters replyParameters()
      Returns the value of the replyParameters record component.
      Returns:
      the value of the replyParameters record component

    • replyMarkup

      @Nullable public @Nullable ReplyKeyboard replyMarkup()
      Returns the value of the replyMarkup record component.
      Returns:
      the value of the replyMarkup record component