Package org.teleight.teleightbots.api.methods

Record Class PostStory

java.lang.Object
java.lang.Record
org.teleight.teleightbots.api.methods.PostStory
All Implemented Interfaces:
ApiMethod<Story>, MultiPartApiMethod<Story>
public record PostStory(@NotNull String businessConnectionId, @NotNull InputStoryContent content, StoryActivePeriod activePeriod, @Nullable String caption, @Nullable ParseMode parseMode, @Nullable MessageEntity[] captionEntities, @Nullable StoryArea[] areas, boolean postToChatPage, boolean protectContent) extends Record implements MultiPartApiMethod<Story>

  • Constructor Details

    • PostStory

      public PostStory(@NotNull @NotNull String businessConnectionId, @NotNull @NotNull InputStoryContent content, StoryActivePeriod activePeriod, @Nullable @Nullable String caption, @Nullable @Nullable ParseMode parseMode, @Nullable @Nullable MessageEntity[] captionEntities, @Nullable @Nullable StoryArea[] areas, boolean postToChatPage, boolean protectContent)
      Creates an instance of a PostStory record class.
      Parameters:
      businessConnectionId - the value for the businessConnectionId record component
      content - the value for the content record component
      activePeriod - the value for the activePeriod record component
      caption - the value for the caption record component
      parseMode - the value for the parseMode record component
      captionEntities - the value for the captionEntities record component
      areas - the value for the areas record component
      postToChatPage - the value for the postToChatPage record component
      protectContent - the value for the protectContent record component

  • Method Details

    • ofBuilder

      @NotNull public static @NotNull lombok.Builder ofBuilder(String businessConnectionId, InputStoryContent content, StoryActivePeriod activePeriod)

    • deserializeResponse

      @NotNull public @NotNull Story deserializeResponse(@NotNull @NotNull String answer)
      Description copied from interface: ApiMethod
      Deserializes the response from the Telegram Bot API.
      Specified by:
      deserializeResponse in interface ApiMethod<Story>
      Parameters:
      answer - the response from the Telegram Bot API
      Returns:
      the deserialized response

    • 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<Story>
      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<Story>
      Returns:
      a map containing the parameters of the multipart API method

    • 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 '=='.
      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

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

    • content

      @NotNull public @NotNull InputStoryContent content()
      Returns the value of the content record component.
      Returns:
      the value of the content record component

    • activePeriod

      public StoryActivePeriod activePeriod()
      Returns the value of the activePeriod record component.
      Returns:
      the value of the activePeriod record component

    • caption

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

    • parseMode

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

    • captionEntities

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

    • areas

      @Nullable public @Nullable StoryArea[] areas()
      Returns the value of the areas record component.
      Returns:
      the value of the areas record component

    • postToChatPage

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

    • protectContent

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