org.tinymediamanager.jsonrpc.api.call.Favourites Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kodi-json-rpc Show documentation
This library is the result of freezy's Kodi JSON introspection, merged with dereulenspiegel's adoption without android, and patched to Kodi 16 Jarvis.
The newest version!
/*
 *      Copyright (C) 2005-2013 Team XBMC
 *      http://xbmc.org
 *
 *  This Program 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 2, or (at your option)
 *  any later version.
 *
 *  This Program 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 XBMC Remote; see the file license.  If not, write to
 *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 *  http://www.gnu.org/copyleft/gpl.html
 *
 */
package org.tinymediamanager.jsonrpc.api.call;

import java.util.ArrayList;

import org.codehaus.jackson.JsonNode;
import org.codehaus.jackson.node.ArrayNode;
import org.codehaus.jackson.node.ObjectNode;
import org.tinymediamanager.jsonrpc.api.AbstractCall;
import org.tinymediamanager.jsonrpc.api.model.FavouriteModel;

public final class Favourites {

  /**
   * Add a favourite with the given details.
   * 
   * This class represents the API method Favourites.AddFavourite
   * 

   * This class was generated automatically from XBMC's JSON-RPC introspect.
   */
  public static class AddFavourite extends AbstractCall {
    public final static String API_TYPE = "Favourites.AddFavourite";

    /**
     * Add a favourite with the given details.
     * 
     * @param title
     * @param type
     *          One of: media, window, script, unknown. See constants at {@link FavouriteModel.Type}.
     * @param path
     *          Required for media and script favourites types.
     * @param window
     *          Required for window favourite type.
     * @param windowparameter
     * @param thumbnail
     */
    public AddFavourite(String title, String type, String path, String window, String windowparameter, String thumbnail) {
      super();
      addParameter("title", title);
      addParameter("type", type);
      addParameter("path", path);
      addParameter("window", window);
      addParameter("windowparameter", windowparameter);
      addParameter("thumbnail", thumbnail);
    }

    @Override
    protected String parseOne(JsonNode node) {
      return node.getTextValue();
    }

    @Override
    public String getName() {
      return API_TYPE;
    }

    @Override
    protected boolean returnsList() {
      return false;
    }
  }

  /**
   * Retrieve all favourites.
   * 

   * This class represents the API method Favourites.GetFavourites
   * 
   * This class was generated automatically from XBMC's JSON-RPC introspect.
   */
  public static class GetFavourites extends AbstractCall {
    public final static String API_TYPE = "Favourites.GetFavourites";
    public final static String RESULT   = "favourites";

    /**
     * Retrieve all favourites.
     * 
     * @param type
     *          One of: media, window, script, unknown. See constants at {@link FavouriteModel.Type}.
     * @param properties
     *          One or more of: window, windowparameter, thumbnail, path. See constants at
     *          {@link FavouriteModel.FavouriteFields}.
     */
    public GetFavourites(String type, String... properties) {
      super();
      addParameter("type", type);
      addParameter("properties", properties);
    }

    @Override
    protected ArrayList parseMany(JsonNode node) {
      final ArrayNode favourites = parseResults(node, RESULT);
      if (favourites != null) {
        final ArrayList ret = new ArrayList(favourites.size());
        for (int i = 0; i < favourites.size(); i++) {
          final ObjectNode item = (ObjectNode) favourites.get(i);
          ret.add(new FavouriteModel.FavouriteDetail(item));
        }
        return ret;
      }
      else {
        return new ArrayList(0);
      }
    }

    @Override
    public String getName() {
      return API_TYPE;
    }

    @Override
    protected boolean returnsList() {
      return true;
    }
  }
}