// Generated by delombok at Tue Dec 10 13:42:03 UTC 2024
/*
 * Copyright (c) 2010-2024 Mark Allen, Norbert Bartels.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.restfb.types;

import static java.util.Collections.unmodifiableList;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import com.restfb.Facebook;
import com.restfb.JsonMapper.JsonMappingCompleted;
import com.restfb.json.Json;
import com.restfb.json.JsonValue;
import com.restfb.types.features.HasCreatedTime;
import com.restfb.types.features.HasFrom;
import com.restfb.types.features.HasMessage;

/**
 * Represents the <a href="https://developers.facebook.com/docs/graph-api/reference/message/">Message Graph API type</a>
 * .
 *
 * @author <a href="http://restfb.com">Mark Allen</a>
 * @author Felipe Kurkowski
 * @author alockhart
 */
public class Message extends FacebookType implements HasCreatedTime, HasFrom, HasMessage {
  /**
   * The time the message was initially created.
   */
  @Facebook("created_time")
  private Date createdTime;
  /**
   * The subject of the message.
   */
  @Facebook
  private String subject;
  /**
   * The sender of this message
   */
  @Facebook
  private ExtendedReferenceType from;
  @Facebook
  private List<ExtendedReferenceType> to = new ArrayList<>();
  @Facebook("is_unsupported")
  private boolean isUnsupported = false;
  /**
   * The text of the message
   */
  @Facebook
  private String message;
  /**
   * Sticker contained in the message.
   */
  @Facebook
  private String sticker;
  @Facebook
  private List<Reaction> reactions = new ArrayList<>();
  @Facebook
  private List<Attachment> attachments = new ArrayList<>();
  @Facebook
  private List<Share> shares = new ArrayList<>();
  @Facebook
  private Story story;
  /**
   * The time of the last update to this message.
   */
  @Facebook("updated_time")
  private Date updatedTime;
  /**
   * The "unread" count for this message.
   */
  @Facebook
  private Integer unread;
  /**
   * Whether this message has been seen.
   */
  @Facebook
  private Boolean unseen;
  @Facebook("tags")
  private transient String rawTags;
  private List<String> tags = new ArrayList<>();
  private static final long serialVersionUID = 1L;


  /**
   * Represents an attached file that you may find on a private message.
   *
   * @author alockhart
   * @since 1.6.12
   */
  public static class Attachment extends FacebookType {
    private static final long serialVersionUID = 1L;
    /**
     * The attachment's filename, for example 121423423.jpg.
     */
    @Facebook
    private String name;
    /**
     * The attachment's mime type, for example image/jpeg.
     */
    @Facebook("mime_type")
    private String mimeType;
    /**
     * The size of the attachment in bytes.
     */
    @Facebook
    private Long size;
    @Facebook("file_url")
    private String fileUrl;
    /**
     * When the attached file is an image, Facebook will also send information about its width, height and url.
     */
    @Facebook("image_data")
    private ImageData imageData;
    /**
     * When the attached file is a video, Facebook will also send information about its width, height and url.
     */
    @Facebook("video_data")
    private VideoData videoData;

    /**
     * returns if the attachment is an image
     * 
     * @return true if the attachment is an image, false otherwise
     */
    public boolean isImage() {
      return null != imageData && null == videoData;
    }

    /**
     * returns if the attachment is a video
     * 
     * @return true if the attachment is a video, false otherwise
     */
    public boolean isVideo() {
      return null != videoData;
    }

    /**
     * returns if the attachment is a placeholder for the real attachment, that is not accessible via API due to privacy
     * rules in Europe
     *
     * check <a href="https://developers.facebook.com/docs/messenger-platform/europe-updates">at Facebook</a>
     *
     * @return true if not accessible in the EU
     */
    public boolean isRemovedInEurope() {
      return "1234".equals(getId());
    }

    /**
     * The attachment's filename, for example 121423423.jpg.
     *
     * @return The attachment's filename.
     */
    @java.lang.SuppressWarnings("all")
    public String getName() {
      return this.name;
    }

    /**
     * The attachment's filename, for example 121423423.jpg.
     */
    @java.lang.SuppressWarnings("all")
    public void setName(final String name) {
      this.name = name;
    }

    /**
     * The attachment's mime type, for example image/jpeg.
     *
     * @return The attachment's mime type.
     */
    @java.lang.SuppressWarnings("all")
    public String getMimeType() {
      return this.mimeType;
    }

    /**
     * The attachment's mime type, for example image/jpeg.
     */
    @java.lang.SuppressWarnings("all")
    public void setMimeType(final String mimeType) {
      this.mimeType = mimeType;
    }

    /**
     * The size of the attachment in bytes.
     *
     * @return The size of the attachment in bytes.
     */
    @java.lang.SuppressWarnings("all")
    public Long getSize() {
      return this.size;
    }

    /**
     * The size of the attachment in bytes.
     */
    @java.lang.SuppressWarnings("all")
    public void setSize(final Long size) {
      this.size = size;
    }

    @java.lang.SuppressWarnings("all")
    public String getFileUrl() {
      return this.fileUrl;
    }

    @java.lang.SuppressWarnings("all")
    public void setFileUrl(final String fileUrl) {
      this.fileUrl = fileUrl;
    }

    /**
     * When the attached file is an image, Facebook will also send information about its width, height and url.
     *
     * @return The attachment's image data.
     */
    @java.lang.SuppressWarnings("all")
    public ImageData getImageData() {
      return this.imageData;
    }

    /**
     * When the attached file is an image, Facebook will also send information about its width, height and url.
     */
    @java.lang.SuppressWarnings("all")
    public void setImageData(final ImageData imageData) {
      this.imageData = imageData;
    }

    /**
     * When the attached file is a video, Facebook will also send information about its width, height and url.
     *
     * @return The attachment's video data.
     */
    @java.lang.SuppressWarnings("all")
    public VideoData getVideoData() {
      return this.videoData;
    }

    /**
     * When the attached file is a video, Facebook will also send information about its width, height and url.
     */
    @java.lang.SuppressWarnings("all")
    public void setVideoData(final VideoData videoData) {
      this.videoData = videoData;
    }
  }


  /**
   * Represents the <a href="https://developers.facebook.com/docs/graph-api/reference/message/shares/">Message Share
   * Graph API type</a>.
   */
  public static class Share extends NamedFacebookType {
    /**
     * The URL to the shared item.
     */
    @Facebook
    private String link;
    /**
     * The description of the shared item.
     */
    @Facebook
    private String description;
    @Facebook
    private String picture;

    /**
     * The URL to the shared item.
     *
     * @return The URL to the shared item.
     */
    @java.lang.SuppressWarnings("all")
    public String getLink() {
      return this.link;
    }

    /**
     * The URL to the shared item.
     */
    @java.lang.SuppressWarnings("all")
    public void setLink(final String link) {
      this.link = link;
    }

    /**
     * The description of the shared item.
     *
     * @return The description of the shared item.
     */
    @java.lang.SuppressWarnings("all")
    public String getDescription() {
      return this.description;
    }

    /**
     * The description of the shared item.
     */
    @java.lang.SuppressWarnings("all")
    public void setDescription(final String description) {
      this.description = description;
    }

    @java.lang.SuppressWarnings("all")
    public String getPicture() {
      return this.picture;
    }

    @java.lang.SuppressWarnings("all")
    public void setPicture(final String picture) {
      this.picture = picture;
    }
  }


  /**
   * Additional attachment information, only present when an attached file is an image.
   *
   * @author Felipe Kurkowski
   */
  public static class ImageData extends AttachmentData {
    private static final long serialVersionUID = 1L;
    /**
     * The image's max width.
     */
    @Facebook("max_width")
    private int maxWidth;
    /**
     * The image's max height.
     */
    @Facebook("max_height")
    private int maxHeight;
    @Facebook("render_as_sticker")
    private Boolean renderAsSticker;
    @Facebook("image_type")
    private int imageType;
    @Facebook("raw_gif_image")
    private String rawGifImage;
    @Facebook("raw_webp_image")
    private String rawWebpImage;
    @Facebook("animated_gif_url")
    private String animatedGifUrl;
    @Facebook("animated_gif_preview_url")
    private String animatedGifPreviewUrl;
    @Facebook("animated_webp_url")
    private String animatedWebpUrl;
    @Facebook("animated_webp_preview_url")
    private String animatedWebpPreviewUrl;

    /**
     * The image's max width.
     *
     * @return The image's max width.
     */
    @java.lang.SuppressWarnings("all")
    public int getMaxWidth() {
      return this.maxWidth;
    }

    /**
     * The image's max width.
     */
    @java.lang.SuppressWarnings("all")
    public void setMaxWidth(final int maxWidth) {
      this.maxWidth = maxWidth;
    }

    /**
     * The image's max height.
     *
     * @return The image's max height.
     */
    @java.lang.SuppressWarnings("all")
    public int getMaxHeight() {
      return this.maxHeight;
    }

    /**
     * The image's max height.
     */
    @java.lang.SuppressWarnings("all")
    public void setMaxHeight(final int maxHeight) {
      this.maxHeight = maxHeight;
    }

    @java.lang.SuppressWarnings("all")
    public Boolean getRenderAsSticker() {
      return this.renderAsSticker;
    }

    @java.lang.SuppressWarnings("all")
    public void setRenderAsSticker(final Boolean renderAsSticker) {
      this.renderAsSticker = renderAsSticker;
    }

    @java.lang.SuppressWarnings("all")
    public int getImageType() {
      return this.imageType;
    }

    @java.lang.SuppressWarnings("all")
    public void setImageType(final int imageType) {
      this.imageType = imageType;
    }

    @java.lang.SuppressWarnings("all")
    public String getRawGifImage() {
      return this.rawGifImage;
    }

    @java.lang.SuppressWarnings("all")
    public void setRawGifImage(final String rawGifImage) {
      this.rawGifImage = rawGifImage;
    }

    @java.lang.SuppressWarnings("all")
    public String getRawWebpImage() {
      return this.rawWebpImage;
    }

    @java.lang.SuppressWarnings("all")
    public void setRawWebpImage(final String rawWebpImage) {
      this.rawWebpImage = rawWebpImage;
    }

    @java.lang.SuppressWarnings("all")
    public String getAnimatedGifUrl() {
      return this.animatedGifUrl;
    }

    @java.lang.SuppressWarnings("all")
    public void setAnimatedGifUrl(final String animatedGifUrl) {
      this.animatedGifUrl = animatedGifUrl;
    }

    @java.lang.SuppressWarnings("all")
    public String getAnimatedGifPreviewUrl() {
      return this.animatedGifPreviewUrl;
    }

    @java.lang.SuppressWarnings("all")
    public void setAnimatedGifPreviewUrl(final String animatedGifPreviewUrl) {
      this.animatedGifPreviewUrl = animatedGifPreviewUrl;
    }

    @java.lang.SuppressWarnings("all")
    public String getAnimatedWebpUrl() {
      return this.animatedWebpUrl;
    }

    @java.lang.SuppressWarnings("all")
    public void setAnimatedWebpUrl(final String animatedWebpUrl) {
      this.animatedWebpUrl = animatedWebpUrl;
    }

    @java.lang.SuppressWarnings("all")
    public String getAnimatedWebpPreviewUrl() {
      return this.animatedWebpPreviewUrl;
    }

    @java.lang.SuppressWarnings("all")
    public void setAnimatedWebpPreviewUrl(final String animatedWebpPreviewUrl) {
      this.animatedWebpPreviewUrl = animatedWebpPreviewUrl;
    }
  }


  /**
   * Additional attachment information, only present when an attached file is a video.
   */
  public static class VideoData extends AttachmentData {
    private static final long serialVersionUID = 1L;
    @Facebook
    private int length;
    @Facebook("video_type")
    private int videoType;
    @Facebook
    private int rotation;

    @java.lang.SuppressWarnings("all")
    public int getLength() {
      return this.length;
    }

    @java.lang.SuppressWarnings("all")
    public void setLength(final int length) {
      this.length = length;
    }

    @java.lang.SuppressWarnings("all")
    public int getVideoType() {
      return this.videoType;
    }

    @java.lang.SuppressWarnings("all")
    public void setVideoType(final int videoType) {
      this.videoType = videoType;
    }

    @java.lang.SuppressWarnings("all")
    public int getRotation() {
      return this.rotation;
    }

    @java.lang.SuppressWarnings("all")
    public void setRotation(final int rotation) {
      this.rotation = rotation;
    }
  }


  public static abstract class AttachmentData extends AbstractFacebookType {
    private static final long serialVersionUID = 1L;
    /**
     * The image's width.
     */
    @Facebook
    private int width;
    /**
     * The image's height.
     */
    @Facebook
    private int height;
    /**
     * The image's url.
     */
    @Facebook
    private String url;
    /**
     * The image's preview url.
     */
    @Facebook("preview_url")
    private String previewUrl;

    /**
     * The image's width.
     *
     * @return The image's width.
     */
    @java.lang.SuppressWarnings("all")
    public int getWidth() {
      return this.width;
    }

    /**
     * The image's width.
     */
    @java.lang.SuppressWarnings("all")
    public void setWidth(final int width) {
      this.width = width;
    }

    /**
     * The image's height.
     *
     * @return The image's height.
     */
    @java.lang.SuppressWarnings("all")
    public int getHeight() {
      return this.height;
    }

    /**
     * The image's height.
     */
    @java.lang.SuppressWarnings("all")
    public void setHeight(final int height) {
      this.height = height;
    }

    /**
     * The image's url.
     *
     * @return The image's url.
     */
    @java.lang.SuppressWarnings("all")
    public String getUrl() {
      return this.url;
    }

    /**
     * The image's url.
     */
    @java.lang.SuppressWarnings("all")
    public void setUrl(final String url) {
      this.url = url;
    }

    /**
     * The image's preview url.
     *
     * @return The image's preview url.
     */
    @java.lang.SuppressWarnings("all")
    public String getPreviewUrl() {
      return this.previewUrl;
    }

    /**
     * The image's preview url.
     */
    @java.lang.SuppressWarnings("all")
    public void setPreviewUrl(final String previewUrl) {
      this.previewUrl = previewUrl;
    }
  }


  public static class Reaction extends AbstractFacebookType {
    @Facebook
    private String reaction;
    @Facebook
    private List<ExtendedReferenceType> users = new ArrayList<>();

    public List<ExtendedReferenceType> getUsers() {
      return users;
    }

    public boolean addUser(ExtendedReferenceType user) {
      return users.add(user);
    }

    public boolean removeUser(ExtendedReferenceType user) {
      return users.remove(user);
    }

    @java.lang.SuppressWarnings("all")
    public String getReaction() {
      return this.reaction;
    }

    @java.lang.SuppressWarnings("all")
    public void setReaction(final String reaction) {
      this.reaction = reaction;
    }
  }


  public static class Story extends AbstractFacebookType {
    @Facebook("reply_to")
    StoryReply replyTo;
    @Facebook
    StoryMention mention;

    @java.lang.SuppressWarnings("all")
    public StoryReply getReplyTo() {
      return this.replyTo;
    }

    @java.lang.SuppressWarnings("all")
    public void setReplyTo(final StoryReply replyTo) {
      this.replyTo = replyTo;
    }

    @java.lang.SuppressWarnings("all")
    public StoryMention getMention() {
      return this.mention;
    }

    @java.lang.SuppressWarnings("all")
    public void setMention(final StoryMention mention) {
      this.mention = mention;
    }
  }


  public static class StoryReply extends FacebookType {
    @Facebook
    private String link;

    @java.lang.SuppressWarnings("all")
    public String getLink() {
      return this.link;
    }

    @java.lang.SuppressWarnings("all")
    public void setLink(final String link) {
      this.link = link;
    }
  }


  public static class StoryMention extends FacebookType {
    @Facebook
    private String link;

    @java.lang.SuppressWarnings("all")
    public String getLink() {
      return this.link;
    }

    @java.lang.SuppressWarnings("all")
    public void setLink(final String link) {
      this.link = link;
    }
  }

  @JsonMappingCompleted
  void convertTags() {
    if (rawTags != null) {
      JsonValue parsedObject = Json.parse(rawTags);
      if (parsedObject.isObject() && parsedObject.asObject().get("data").isArray()) {
        for (JsonValue tagObject : parsedObject.asObject().get("data").asArray()) {
          tags.add(tagObject.asObject().get("name").asString());
        }
      }
    }
  }

  /**
   * The attachments associated with the message.
   *
   * @return The attachments associated with the message.
   */
  public List<Attachment> getAttachments() {
    return (attachments != null ? unmodifiableList(attachments) : null);
  }

  public boolean addAttachment(Attachment attachment) {
    return attachments.add(attachment);
  }

  public boolean removeAttachment(Attachment attachment) {
    return attachments.remove(attachment);
  }

  /**
   * The shares associated with the message.
   * <p>
   * This is page only.
   *
   * @return The shares associated with the message.
   */
  public List<Share> getShares() {
    return (shares != null ? unmodifiableList(shares) : null);
  }

  public boolean addShare(Share share) {
    return shares.add(share);
  }

  public boolean removeShare(Share share) {
    return shares.remove(share);
  }

  /**
   * A list of recipients of the message.
   *
   * @return A list of the message recipients
   */
  public List<ExtendedReferenceType> getTo() {
    return unmodifiableList(to);
  }

  public boolean addTo(ExtendedReferenceType receiver) {
    return to.add(receiver);
  }

  public boolean removeTo(ExtendedReferenceType receiver) {
    return to.remove(receiver);
  }

  /**
   * A set of tags indicating the message folder and source of the message.
   *
   * @return A set of tags indicating the message folder and source of the message.
   */
  public List<String> getTags() {
    return unmodifiableList(tags);
  }

  public boolean addTag(String tag) {
    return tags.add(tag);
  }

  public boolean removeTag(String tag) {
    return tags.remove(tag);
  }

  /**
   * Reaction (like/love) on the existing message
   *
   * @return list of reactions
   */
  public List<Reaction> getReactions() {
    return unmodifiableList(reactions);
  }

  public boolean addReaction(Reaction reaction) {
    return reactions.add(reaction);
  }

  public boolean removeReaction(Reaction reaction) {
    return reactions.remove(reaction);
  }

  /**
   * The time the message was initially created.
   *
   * @return The time the message was initially created.
   */
  @Override
  @java.lang.SuppressWarnings("all")
  public Date getCreatedTime() {
    return this.createdTime;
  }

  /**
   * The time the message was initially created.
   */
  @java.lang.SuppressWarnings("all")
  public void setCreatedTime(final Date createdTime) {
    this.createdTime = createdTime;
  }

  /**
   * The subject of the message.
   *
   * @return The subject of the message.
   */
  @java.lang.SuppressWarnings("all")
  public String getSubject() {
    return this.subject;
  }

  /**
   * The subject of the message.
   */
  @java.lang.SuppressWarnings("all")
  public void setSubject(final String subject) {
    this.subject = subject;
  }

  /**
   * The sender of this message
   *
   * @return The sender of this message
   */
  @Override
  @java.lang.SuppressWarnings("all")
  public ExtendedReferenceType getFrom() {
    return this.from;
  }

  /**
   * The sender of this message
   */
  @java.lang.SuppressWarnings("all")
  public void setFrom(final ExtendedReferenceType from) {
    this.from = from;
  }

  @java.lang.SuppressWarnings("all")
  public boolean isUnsupported() {
    return this.isUnsupported;
  }

  @java.lang.SuppressWarnings("all")
  public void setUnsupported(final boolean isUnsupported) {
    this.isUnsupported = isUnsupported;
  }

  /**
   * The text of the message
   *
   * @return The text of the message
   */
  @Override
  @java.lang.SuppressWarnings("all")
  public String getMessage() {
    return this.message;
  }

  /**
   * The text of the message
   */
  @java.lang.SuppressWarnings("all")
  public void setMessage(final String message) {
    this.message = message;
  }

  /**
   * Sticker contained in the message.
   *
   * @return The Sticker in that message
   */
  @java.lang.SuppressWarnings("all")
  public String getSticker() {
    return this.sticker;
  }

  /**
   * Sticker contained in the message.
   */
  @java.lang.SuppressWarnings("all")
  public void setSticker(final String sticker) {
    this.sticker = sticker;
  }

  @java.lang.SuppressWarnings("all")
  public Story getStory() {
    return this.story;
  }

  @java.lang.SuppressWarnings("all")
  public void setStory(final Story story) {
    this.story = story;
  }

  /**
   * The time of the last update to this message.
   *
   * @return The time of the last update to this message.
   */
  @java.lang.SuppressWarnings("all")
  public Date getUpdatedTime() {
    return this.updatedTime;
  }

  /**
   * The time of the last update to this message.
   */
  @java.lang.SuppressWarnings("all")
  public void setUpdatedTime(final Date updatedTime) {
    this.updatedTime = updatedTime;
  }

  /**
   * The "unread" count for this message.
   *
   * @return The "unread" count for this message.
   */
  @java.lang.SuppressWarnings("all")
  public Integer getUnread() {
    return this.unread;
  }

  /**
   * The "unread" count for this message.
   */
  @java.lang.SuppressWarnings("all")
  public void setUnread(final Integer unread) {
    this.unread = unread;
  }

  /**
   * Whether this message has been seen.
   *
   * @return Whether this message has been seen.
   */
  @java.lang.SuppressWarnings("all")
  public Boolean getUnseen() {
    return this.unseen;
  }

  /**
   * Whether this message has been seen.
   */
  @java.lang.SuppressWarnings("all")
  public void setUnseen(final Boolean unseen) {
    this.unseen = unseen;
  }
}