Android Open Source - Todo Remote Client

From Project

Back to project page Todo.

License

The source code is released under:

GNU General Public License

If you think the Android project Todo listed in this page is inappropriate, such as containing malicious code/tools or violating the copyright, please email info at java2s dot com, thanks.

Java Source Code

/**
 * This file is part of Todo.txt for Android, an app for managing your todo.txt file (http://todotxt.com).
 *// www.ja va2 s.  c  o  m
 * Copyright (c) 2009-2013 Todo.txt for Android contributors (http://todotxt.com)
 *
 * LICENSE:
 *
 * Todo.txt for Android 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 of the License, or (at your option) any
 * later version.
 *
 * Todo.txt for Android 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 Todo.txt for Android. If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * Todo.txt for Android's source code is available at https://github.com/ginatrapani/todo.txt-android
 *
 * @author Todo.txt for Android contributors <todotxt@yahoogroups.com>
 * @license http://www.gnu.org/licenses/gpl.html
 * @copyright 2009-2013 Todo.txt for Android contributors (http://todotxt.com)
 */

package com.todotxt.todotxttouch.remote;

import java.io.File;
import java.util.List;

public interface RemoteClient {
  Client getClient();

  /**
   * Attempts to authenticate with remote api
   * @return true if successful
   */
  boolean authenticate();

  /**
   * Starts the login with remote api
   * @return true if successful
   */
  boolean startLogin();

  /**
   * Implement this for two-step oAuth type login to finish the process. Call
   * this from the onResume() of your activity
   * @return true if successful
   */
  boolean finishLogin();

  /**
   * Attempts to deauthenticate with remote api
   */
  void deauthenticate();

  /**
   * Check to see if we are authenticated with remote api
   * @return true if authenticated
   */
  boolean isAuthenticated();

  /**
   * Check to see if we have enough information to authenticate with remote
   * api
   * @return true if we have authToken, false if we need login information
   * @deprecated This is information internal to the remote service. Will be
   * removed. Use {@link RemoteClient#isAuthenticated()} instead.
   */
  boolean isLoggedIn();

  /**
   * Pull the remote Todo.txt file
   */
  PullTodoResult pullTodo();

  /**
   * Push mobile
   * @param overwrite if true, upload the files even if there is a remote conflict.
   */
  void pushTodo(File todoFile, File doneFile, boolean overwrite);

  /**
   * A method to check if the remote service is available (network, sd-card,
   * etc)
   * @return true if available, false if not
   */
  boolean isAvailable();

  List<RemoteFolder> getSubFolders(String path);

  RemoteFolder getFolder(String path);
}

Java Source Code List