001// Generated by delombok at Fri Oct 11 21:56:29 CEST 2019
002/**
003 * Copyright (c) 2010-2019 Mark Allen, Norbert Bartels.
004 *
005 * Permission is hereby granted, free of charge, to any person obtaining a copy
006 * of this software and associated documentation files (the "Software"), to deal
007 * in the Software without restriction, including without limitation the rights
008 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
009 * copies of the Software, and to permit persons to whom the Software is
010 * furnished to do so, subject to the following conditions:
011 *
012 * The above copyright notice and this permission notice shall be included in
013 * all copies or substantial portions of the Software.
014 *
015 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
016 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
017 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
018 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
019 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
020 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
021 * THE SOFTWARE.
022 */
023package com.restfb.types;
024
025import com.restfb.Facebook;
026import com.restfb.JsonMapper;
027
028/**
029 * Type that can be used as return value for publishing new objects to Facebook.
030 * 
031 * Id, post_id and success field are accessible. Have a look at the fields and methods javadoc
032 */
033public class GraphResponse {
034  /**
035   * <code>true</code> if publishing of the object was successful, <code>false</code> otherwise.
036   *
037   * if the success field is not provided by Facebook, we check if the id field is present
038   */
039  @Facebook
040  private boolean success;
041  @Facebook
042  private String id;
043  @Facebook("post_id")
044  private String postId;
045
046  /**
047   * returns the id that is used for the post or comment.
048   * 
049   * Normally the <code>id</code> of the newly object is returned, but after publishing a photo the <code>post id</code>
050   * is returned. So you get the id of the corresponding post without put the logic in your application.
051   * 
052   * Attention: if you publish a photo without story you get the photo id here
053   *
054   * @return id of the new created post / comment
055   */
056  public String getTimelineId() {
057    return postId != null ? postId : id;
058  }
059
060  @JsonMapper.JsonMappingCompleted
061  protected void check() {
062    if (id != null) {
063      success = true;
064    }
065  }
066
067  /**
068   * <code>true</code> if publishing of the object was successful, <code>false</code> otherwise.
069   *
070   * if the success field is not provided by Facebook, we check if the id field is present
071   */
072  @java.lang.SuppressWarnings("all")
073  public boolean isSuccess() {
074    return this.success;
075  }
076
077  /**
078   * <code>true</code> if publishing of the object was successful, <code>false</code> otherwise.
079   *
080   * if the success field is not provided by Facebook, we check if the id field is present
081   */
082  @java.lang.SuppressWarnings("all")
083  public void setSuccess(final boolean success) {
084    this.success = success;
085  }
086
087  @java.lang.SuppressWarnings("all")
088  public String getId() {
089    return this.id;
090  }
091
092  @java.lang.SuppressWarnings("all")
093  public void setId(final String id) {
094    this.id = id;
095  }
096
097  @java.lang.SuppressWarnings("all")
098  public String getPostId() {
099    return this.postId;
100  }
101
102  @java.lang.SuppressWarnings("all")
103  public void setPostId(final String postId) {
104    this.postId = postId;
105  }
106}