net.jeremybrooks.jinx.api.PrefsApi Maven / Gradle / Ivy

Go to download
/*
 * Jinx is Copyright 2010-2020 by Jeremy Brooks and Contributors
 *
 * Jinx is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Jinx is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Jinx.  If not, see .
 */

package net.jeremybrooks.jinx.api;

import net.jeremybrooks.jinx.Jinx;
import net.jeremybrooks.jinx.JinxException;
import net.jeremybrooks.jinx.response.people.Person;

import java.util.Map;
import java.util.TreeMap;

/**
 * Provides access to the flickr.prefs API methods.
 *
 * The methods in this class return a {@link Person} object, but only the {@link Person#getUserId()} and
 * the preference getters will have values set.
 *
 * @author Jeremy Brooks
 * @see Flickr API documentation for more details.
 */
public class PrefsApi {
  private Jinx jinx;

  private PrefsApi() {
  }

  public PrefsApi(Jinx jinx) {
    this.jinx = jinx;
  }

  /**
   * Returns the default content type preference for the user.
   *
   * Authentication
   *
   * This method requires authentication with 'read' permission.
   *
   * @return person object with nsid and contentType fields set.
   * @throws JinxException if there are any errors.
   * @see flickr.prefs.getContentType
   */
  public Person getContentType() throws JinxException {
    Map params = new TreeMap<>();
    params.put("method", "flickr.prefs.getContentType");
    return jinx.flickrGet(params, Person.class);
  }


  /**
   * Returns the default privacy level for geographic information attached to the user's
   * photos and whether or not the user has chosen to use geo-related EXIF information to
   * automatically geotag their photos.
   *
   * Possible values, for viewing geotagged photos, are:
   *
   * 0 : No default set
   * 1 : Public
   * 2 : Contacts only
   * 3 : Friends and Family only
   * 4 : Friends only
   * 5 : Family only
   * 6 : Private
   * Users can edit this preference at http://www.flickr.com/account/geo/privacy/.
   *
   * Possible values for whether or not geo-related EXIF information will be used to geotag a photo are:
   * 0: Geo-related EXIF information will be ignored
   * 1: Geo-related EXIF information will be used to try and geotag photos on upload
   * Users can edit this preference at http://www.flickr.com/account/geo/exif/?from=privacy
   *
   * Authentication
   *
   * This method requires authentication with 'read' permission.
   *
   * @return person object with nsid, geoPerms, and importGeoExif fields set.
   * @throws JinxException if there are any errors.
   * @see flickr.prefs.getGeoPerms
   */
  public Person getGeoPerms() throws JinxException {
    Map params = new TreeMap<>();
    params.put("method", "flickr.prefs.getGeoPerms");
    return jinx.flickrGet(params, Person.class);
  }

  /**
   * Returns the default hidden preference for the user.
   *
   * Authentication
   *
   * This method requires authentication with 'read' permission.
   *
   * @return person object with nsid and hidden fields set.
   * @throws JinxException if there are any errors.
   * @see flickr.prefs.getHidden
   */
  public Person getHidden() throws JinxException {
    Map params = new TreeMap<>();
    params.put("method", "flickr.prefs.getHidden");
    return jinx.flickrGet(params, Person.class);
  }

  /**
   * Returns the default privacy level preference for the user. Possible values are:
   *
   * 1 : Public
   * 2 : Friends only
   * 3 : Family only
   * 4 : Friends and Family
   * 5 : Private
   *
   * Authentication
   *
   * This method requires authentication with 'read' permission.
   *
   * @return person object with nsid and privacy fields set.
   * @throws JinxException if there are any errors.
   * @see flickr.prefs.getPrivacy
   */
  public Person getPrivacy() throws JinxException {
    Map params = new TreeMap<>();
    params.put("method", "flickr.prefs.getPrivacy");
    return jinx.flickrGet(params, Person.class);
  }

  /**
   * Returns the default safety level preference for the user.
   *
   * Authentication
   *
   * This method requires authentication with 'read' permission.
   *
   * @return person object with nsid and safetyLevel fields set.
   * @throws JinxException if there are any errors.
   * @see flickr.prefs.getSafetyLevel
   */
  public Person getSafetyLevel() throws JinxException {
    Map params = new TreeMap<>();
    params.put("method", "flickr.prefs.getSafetyLevel");
    return jinx.flickrGet(params, Person.class);
  }
}