android/playground/src/main/java/org/apache/weex/extend/module/location/ILocatable.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.weex.extend.module.location;

import com.taobao.weex.WXSDKInstance;

/**
 */
public interface ILocatable {

  int REQUEST_CUR_PERMISSION_CODE = 0x12;
  int REQUEST_WATCH_PERMISSION_CODE = 0x13;


  String REQUEST_PERMISSION_CODE = "requestCode";
  String ERROR_CODE = "errorCode";
  String ERROR_MSG = "errorMsg";
  String COORDS = "coords";
  String ADDRESS = "address";
  String WATCH_ID = "watchId";

  interface ErrorCode {

    int SUCCESS = 90000;
    int NO_PERMISSION_ERROR = 90001;
    int PARAMS_ERROR = 90002;
    int LOCATION_ERROR = 9003;
    int LOCATION_TIME_OUT = 9004;
  }

  interface ErrorMsg {

    String NO_PERMISSION_ERROR = "NO PERMISSION";
    String PARAMS_ERROR = "PARAMS_ERROR";
    String LOCATION_ERROR = "LOCATION_FAIL";
    String LOCATION_TIME_OUT = "LOCATION_TIME_OUT";
    String SUCCESS = "SUCCESS";

  }

  /**
   * Get current location information, the callback only once
   *
   * @param successCallback success callback function id.
   * @param errorCallback   error callback function id.(example:no persimmon)
   * @param params          JSON parameter(example:address).
   */
  void getCurrentPosition(String successCallback, String errorCallback, String params);

  /**
   * register global location listener，if location change，you will be notify.
   *
   * @param successCallback location success callback function id.
   * @param errorCallback   location error callback (example:no persimmon).
   * @param params          JSON parameter(example:address).
   */
  void watchPosition(String successCallback, String errorCallback, String params);

  /**
   * remove global location listener.
   *
   * @param watchId register id,you can get from watchPosition method。
   */
  void clearWatch(String watchId);

  /**
   * set instance
   *
   * @param instance instance
   */
  void setWXSDKInstance(WXSDKInstance instance);

  /**
   * this method will call when module destroy.
   */
  void destroy();

}