Package org.teleight.teleightbots.api.objects

Record Class InputMediaPhoto

java.lang.Object
java.lang.Record
org.teleight.teleightbots.api.objects.InputMediaPhoto
All Implemented Interfaces:
Serializable, ApiResult, InputMedia
public record InputMediaPhoto(@NotNull InputFile media, @Nullable String caption, @Nullable ParseMode parseMode, @Nullable MessageEntity[] captionEntities, boolean showCaptionAboveMedia, boolean hasSpoiler) extends Record implements InputMedia
See Also:

  • Field Summary

    Fields inherited from interface org.teleight.teleightbots.api.objects.InputMedia

    TYPE_NAME

  • Constructor Summary

    Constructors
    Constructor
    Description
    InputMediaPhoto(@NotNull InputFile media, @Nullable String caption, @Nullable ParseMode parseMode, @Nullable MessageEntity[] captionEntities, boolean showCaptionAboveMedia, boolean hasSpoiler)
    Creates an instance of a InputMediaPhoto record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable String
    caption()
    Returns the value of the caption record component.
    @Nullable MessageEntity[]
    captionEntities()
    Returns the value of the captionEntities record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    hasSpoiler()
    Returns the value of the hasSpoiler record component.
    @NotNull InputFile
    media()
    Returns the value of the media record component.
    static @NotNull lombok.Builder
    ofBuilder(InputFile media)
     
    @Nullable ParseMode
    parseMode()
    Returns the value of the parseMode record component.
    boolean
    showCaptionAboveMedia()
    Returns the value of the showCaptionAboveMedia record component.
    final String
    toString()
    Returns a string representation of this record class.
    String
    type()
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • InputMediaPhoto

      public InputMediaPhoto(@NotNull @NotNull InputFile media, @Nullable @Nullable String caption, @Nullable @Nullable ParseMode parseMode, @Nullable @Nullable MessageEntity[] captionEntities, boolean showCaptionAboveMedia, boolean hasSpoiler)
      Creates an instance of a InputMediaPhoto record class.
      Parameters:
      media - the value for the media 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
      showCaptionAboveMedia - the value for the showCaptionAboveMedia record component
      hasSpoiler - the value for the hasSpoiler record component

  • Method Details

    • ofBuilder

      @NotNull public static @NotNull lombok.Builder ofBuilder(InputFile media)

    • type

      public String type()
      Specified by:
      type in interface InputMedia

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

    • media

      @NotNull public @NotNull InputFile media()
      Returns the value of the media record component.
      Returns:
      the value of the media 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

    • showCaptionAboveMedia

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

    • hasSpoiler

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