LocationClient

java.lang.Object
- com.baidu.location.LocationClient

All Implemented Interfaces:

com.baidu.location.common.FirstLocRequest.FirstLocationListener, com.baidu.location.utils.LocalDebug, com.baidu.location.utils.VersionConfig
```
public final class LocationClient
extends java.lang.Object
implements com.baidu.location.utils.VersionConfig, com.baidu.location.common.FirstLocRequest.FirstLocationListener
```
定位服务的客户端，宿主程序在客户端声明此类，并调用，目前只支持在主线程中启动

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CONNECT_HOT_SPOT_FALSE` 连接wifi不是移动热点
`static int`	`CONNECT_HOT_SPOT_TRUE` 连接wifi是移动热点
`static int`	`CONNECT_HOT_SPOT_UNKNOWN` 连接移动热点状态未知
`static int`	`LOC_DIAGNOSTIC_TYPE_BETTER_OPEN_GPS` 诊断信息：打开GPS定位会更加精准
`static int`	`LOC_DIAGNOSTIC_TYPE_BETTER_OPEN_WIFI` 诊断信息：打开wifi(不用连接)定位会更加精准
`static int`	`LOC_DIAGNOSTIC_TYPE_FAIL_UNKNOWN` 诊断信息：未知定位异常原因，请确认周围环境或者检查手机有无管家软件没有授权APP定位权限等
`static int`	`LOC_DIAGNOSTIC_TYPE_NEED_CHECK_LOC_PERMISSION` 诊断信息：定位失败，请确认是否授予APP定位权限
`static int`	`LOC_DIAGNOSTIC_TYPE_NEED_CHECK_NET` 诊断信息：定位失败，请检查网络是否畅通
`static int`	`LOC_DIAGNOSTIC_TYPE_NEED_CLOSE_FLYMODE` 诊断信息：飞行模式无法定位，请关闭飞行模式重试
`static int`	`LOC_DIAGNOSTIC_TYPE_NEED_INSERT_SIMCARD_OR_OPEN_WIFI` 诊断信息：无法获取任何定位依据，请插入SIM卡或者打开wifi重试
`static int`	`LOC_DIAGNOSTIC_TYPE_NEED_OPEN_PHONE_LOC_SWITCH` 诊断信息：定位失败，请打开手机定位开关
`static int`	`LOC_DIAGNOSTIC_TYPE_SERVER_FAIL` 诊断信息：服务端定位失败

Fields inherited from interface com.baidu.location.utils.VersionConfig
SDK_VERSION, STRING_VERSION, TRACE_VERSION

Fields inherited from interface com.baidu.location.utils.LocalDebug
Debug

Constructor Summary

Constructors
Constructor and Description
`LocationClient(android.content.Context context)` 构造函数
`LocationClient(android.content.Context context, LocationClientOption locOption)` 构造函数

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`disableAssistantLocation()` 停止H5辅助定位
`void`	`disableLocInForeground(boolean removeNotification)` 关闭前台定位服务
`void`	`enableAssistantLocation(android.webkit.WebView webView)` 开发者应用如果有H5页面使用了百度JS接口，该接口可以辅助百度JS更好的进行定位
`void`	`enableLocInForeground(int id, android.app.Notification notification)` 开发者应用如果有后台定位需求，在退到后台的时候，为了保证定位可以在后台一直运行，可以调用该函数，会将定位SDK的SERVICE设置成为前台服务，适配ANDROID 8后台无法定位问题，其他版本下也会提高定位进程存活率
`java.lang.String`	`getAccessKey()` 获取用户设置的KEY
`static BDLocation`	`getBDLocationInCoorType(BDLocation src, java.lang.String transferType)` 根据设定的转换坐标系类型得到相应坐标系下的BDLocation
`BDLocation`	`getLastKnownLocation()` 同步定位，返回最近一次定位结果
`LocationClientOption`	`getLocOption()`
`java.lang.String`	`getVersion()` 获取定位sdk版本信息
`boolean`	`isStarted()` client是否started，很多开发者会在start之后去检查此函数，定位客户端启动会有一定时间，所以会有一定延时，实际上调用start方法后定位SDK会默认立即发起定位请求，开发者不用额外检查
`void`	`onReceiveLightLocString(java.lang.String locStr)`
`void`	`onReceiveLocation(BDLocation location)`
`void`	`registerLocationListener(BDAbstractLocationListener listener)` 注册 BDAbstractLocationListener 定位监听函数
`void`	`registerLocationListener(BDLocationListener listener)` Deprecated. 请使用registerLocationListener (BDAbstractLocationListener listener)
`void`	`registerNotify(BDNotifyListener mNotify)` 注册位置提醒监听
`void`	`registerNotifyLocationListener(BDLocationListener listener)` NA
`void`	`removeNotifyEvent(BDNotifyListener mNotify)` 取消注册的位置提醒监听
`boolean`	`requestHotSpotState()` 触发请求当前连接wifi是否是移动热点的状态
`int`	`requestLocation()` 请求定位，异步返回，结果在locationListener中获取.
`void`	`requestNotifyLocation()` NA
`int`	`requestOfflineLocation()` 离线定位请求，异步返回，结果在locationListener中获取.
`void`	`restart()` 重启定位SDK,后台常驻运行的APP可以尝试在回到前台的情况下重启定位SDK,防止因长时间后台运行被系统回收定位权限造成定位失败
`void`	`setLocOption(LocationClientOption locOption)` 设置 LocationClientOption
`void`	`start()` 启动定位sdk
`boolean`	`startIndoorMode()` 打开室内定位模式,该模式下会加快定位速度并输出连续室内定位结果；当BDLocation.getFloor() != null时，表明该区域已经支持室内定位，开发者可以尝试调用该接口，体验高精度室内定位功能。
`void`	`stop()` 停止定位sdk
`boolean`	`stopIndoorMode()` 关闭室内定位模式
`void`	`unRegisterLocationListener(BDAbstractLocationListener listener)` 取消之前注册的 BDAbstractLocationListener 定位监听函数
`void`	`unRegisterLocationListener(BDLocationListener listener)` Deprecated. 请使用unRegisterLocationListener(BDAbstractLocationListener listener)
`boolean`	`updateLocation(android.location.Location gpslocation)` NA

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CONNECT_HOT_SPOT_TRUE
```
public static final int CONNECT_HOT_SPOT_TRUE
```
    连接wifi是移动热点
    
    See Also:
    
    Constant Field Values
  - CONNECT_HOT_SPOT_FALSE
```
public static final int CONNECT_HOT_SPOT_FALSE
```
    连接wifi不是移动热点
    
    See Also:
    
    Constant Field Values
  - CONNECT_HOT_SPOT_UNKNOWN
```
public static final int CONNECT_HOT_SPOT_UNKNOWN
```
    连接移动热点状态未知
    
    See Also:
    
    Constant Field Values
  - LOC_DIAGNOSTIC_TYPE_BETTER_OPEN_GPS
```
public static final int LOC_DIAGNOSTIC_TYPE_BETTER_OPEN_GPS
```
    诊断信息：打开GPS定位会更加精准
    
    See Also:
    
    Constant Field Values
  - LOC_DIAGNOSTIC_TYPE_BETTER_OPEN_WIFI
```
public static final int LOC_DIAGNOSTIC_TYPE_BETTER_OPEN_WIFI
```
    诊断信息：打开wifi(不用连接)定位会更加精准
    
    See Also:
    
    Constant Field Values
  - LOC_DIAGNOSTIC_TYPE_NEED_CHECK_NET
```
public static final int LOC_DIAGNOSTIC_TYPE_NEED_CHECK_NET
```
    诊断信息：定位失败，请检查网络是否畅通
    
    See Also:
    
    Constant Field Values
  - LOC_DIAGNOSTIC_TYPE_NEED_CHECK_LOC_PERMISSION
```
public static final int LOC_DIAGNOSTIC_TYPE_NEED_CHECK_LOC_PERMISSION
```
    诊断信息：定位失败，请确认是否授予APP定位权限
    
    See Also:
    
    Constant Field Values
  - LOC_DIAGNOSTIC_TYPE_NEED_OPEN_PHONE_LOC_SWITCH
```
public static final int LOC_DIAGNOSTIC_TYPE_NEED_OPEN_PHONE_LOC_SWITCH
```
    诊断信息：定位失败，请打开手机定位开关
    
    See Also:
    
    Constant Field Values
  - LOC_DIAGNOSTIC_TYPE_NEED_INSERT_SIMCARD_OR_OPEN_WIFI
```
public static final int LOC_DIAGNOSTIC_TYPE_NEED_INSERT_SIMCARD_OR_OPEN_WIFI
```
    诊断信息：无法获取任何定位依据，请插入SIM卡或者打开wifi重试
    
    See Also:
    
    Constant Field Values
  - LOC_DIAGNOSTIC_TYPE_NEED_CLOSE_FLYMODE
```
public static final int LOC_DIAGNOSTIC_TYPE_NEED_CLOSE_FLYMODE
```
    诊断信息：飞行模式无法定位，请关闭飞行模式重试
    
    See Also:
    
    Constant Field Values
  - LOC_DIAGNOSTIC_TYPE_SERVER_FAIL
```
public static final int LOC_DIAGNOSTIC_TYPE_SERVER_FAIL
```
    诊断信息：服务端定位失败
    
    See Also:
    
    Constant Field Values
  - LOC_DIAGNOSTIC_TYPE_FAIL_UNKNOWN
```
public static final int LOC_DIAGNOSTIC_TYPE_FAIL_UNKNOWN
```
    诊断信息：未知定位异常原因，请确认周围环境或者检查手机有无管家软件没有授权APP定位权限等
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LocationClient
```
public LocationClient(android.content.Context context)
```
    构造函数
    
    Parameters:
    
    context - 需要全局有效的context,建议通过getApplicationContext传入
  - LocationClient
```
public LocationClient(android.content.Context context,
                      LocationClientOption locOption)
```
    构造函数
    
    Parameters:
    
    context - 需要全局有效的context,建议通过getApplicationContext传入
    
    locOption - client相关的参数设定
- Method Detail
  - getLocOption
```
public LocationClientOption getLocOption()
```
    Returns:
    
    目前的LocationClientOption 设置
  - setLocOption
```
public void setLocOption(LocationClientOption locOption)
```
    设置 LocationClientOption
    
    Parameters:
    
    locOption - client相关的参数设定
  - updateLocation
```
public boolean updateLocation(android.location.Location gpslocation)
```
    NA
  - requestNotifyLocation
```
public void requestNotifyLocation()
```
    NA
  - requestOfflineLocation
```
public int requestOfflineLocation()
```
    离线定位请求，异步返回，结果在locationListener中获取.
    
    Returns:
    
    0：离线定位请求成功 1:service没有启动 2：无监听函数
  - requestLocation
```
public int requestLocation()
```
    请求定位，异步返回，结果在locationListener中获取.
    
    Returns:
    
    0：离线定位请求成功 1:service没有启动 2：无监听函数 6：两次请求时间太短
  - isStarted
```
public boolean isStarted()
```
    client是否started，很多开发者会在start之后去检查此函数，定位客户端启动会有一定时间，所以会有一定延时，实际上调用start方法后定位SDK会默认立即发起定位请求，开发者不用额外检查
    
    Returns:
    
    boolean
  - getLastKnownLocation
```
public BDLocation getLastKnownLocation()
```
    同步定位，返回最近一次定位结果
    
    Returns:
    
    BDLocation
  - getVersion
```
public java.lang.String getVersion()
```
    获取定位sdk版本信息
    
    Returns:
    
    String
  - restart
```
public void restart()
```
    重启定位SDK,后台常驻运行的APP可以尝试在回到前台的情况下重启定位SDK,防止因长时间后台运行被系统回收定位权限造成定位失败
  - enableLocInForeground
```
public void enableLocInForeground(int id,
                                  android.app.Notification notification)
```
    开发者应用如果有后台定位需求，在退到后台的时候，为了保证定位可以在后台一直运行，可以调用该函数，会将定位SDK的SERVICE设置成为前台服务，适配ANDROID 8后台无法定位问题，其他版本下也会提高定位进程存活率
    
    Parameters:
    
    id - 为通知栏notifation设置唯一id，必须大于0
    
    notification - 开发者自定义通知
  - disableLocInForeground
```
public void disableLocInForeground(boolean removeNotification)
```
    关闭前台定位服务
    
    Parameters:
    
    removeNotification - 是否移除通知栏通知
  - enableAssistantLocation
```
public void enableAssistantLocation(android.webkit.WebView webView)
```
    开发者应用如果有H5页面使用了百度JS接口，该接口可以辅助百度JS更好的进行定位
    
    Parameters:
    
    webView - WebView对象
  - disableAssistantLocation
```
public void disableAssistantLocation()
```
    停止H5辅助定位
  - start
```
public void start()
```
    启动定位sdk
  - stop
```
public void stop()
```
    停止定位sdk
  - registerNotify
```
public void registerNotify(BDNotifyListener mNotify)
```
    注册位置提醒监听
    
    Parameters:
    
    mNotify - 参考位置提醒类
  - removeNotifyEvent
```
public void removeNotifyEvent(BDNotifyListener mNotify)
```
    取消注册的位置提醒监听
    
    Parameters:
    
    mNotify - 参考位置提醒类
  - registerNotifyLocationListener
```
public void registerNotifyLocationListener(BDLocationListener listener)
```
    NA
  - registerLocationListener
```
public void registerLocationListener(BDLocationListener listener)
```
    Deprecated. 请使用registerLocationListener (BDAbstractLocationListener listener)
    
    注册定位监听函数
    
    Parameters:
    
    listener - 注册位置回调接口
  - unRegisterLocationListener
```
public void unRegisterLocationListener(BDLocationListener listener)
```
    Deprecated. 请使用unRegisterLocationListener(BDAbstractLocationListener listener)
    
    取消之前注册的定位监听函数
    
    Parameters:
    
    listener - 取消位置回调接口
  - registerLocationListener
```
public void registerLocationListener(BDAbstractLocationListener listener)
```
    注册 BDAbstractLocationListener 定位监听函数
    
    Parameters:
    
    listener - 注册位置回调接口
  - unRegisterLocationListener
```
public void unRegisterLocationListener(BDAbstractLocationListener listener)
```
    取消之前注册的 BDAbstractLocationListener 定位监听函数
    
    Parameters:
    
    listener - 取消位置回调接口
  - startIndoorMode
```
public boolean startIndoorMode()
```
    打开室内定位模式,该模式下会加快定位速度并输出连续室内定位结果；当BDLocation.getFloor() != null时，表明该区域已经支持室内定位，开发者可以尝试调用该接口，体验高精度室内定位功能。
    
    Returns:
    
    boolean 是否成功
  - stopIndoorMode
```
public boolean stopIndoorMode()
```
    关闭室内定位模式
    
    Returns:
    
    boolean 是否成功
  - requestHotSpotState
```
public boolean requestHotSpotState()
```
    触发请求当前连接wifi是否是移动热点的状态
    
    Returns:
    
    是否请求成功
  - getAccessKey
```
public java.lang.String getAccessKey()
```
    获取用户设置的KEY
    
    Returns:
    
    String
  - getBDLocationInCoorType
```
public static BDLocation getBDLocationInCoorType(BDLocation src,
                                                 java.lang.String transferType)
```
    根据设定的转换坐标系类型得到相应坐标系下的BDLocation
    
    Parameters:
    
    src - 原始BDLocation
    
    transferType - BDLocation.BDLOCATION_GCJ02_TO_BD09/BDLOCATION_GCJ02_TO_BD09LL/BDLOCATION_BD09_TO_GCJ02/ BDLOCATION_BD09LL_TO_GCJ02/BDLOCATION_WGS84_TO_GCJ02
  - onReceiveLocation
```
public void onReceiveLocation(BDLocation location)
```
    Specified by:
    
    onReceiveLocation in interface com.baidu.location.common.FirstLocRequest.FirstLocationListener
  - onReceiveLightLocString
```
public void onReceiveLightLocString(java.lang.String locStr)
```
    Specified by:
    
    onReceiveLightLocString in interface com.baidu.location.common.FirstLocRequest.FirstLocationListener

Class LocationClient

Field Summary

Fields inherited from interface com.baidu.location.utils.VersionConfig

Fields inherited from interface com.baidu.location.utils.LocalDebug

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONNECT_HOT_SPOT_TRUE

CONNECT_HOT_SPOT_FALSE

CONNECT_HOT_SPOT_UNKNOWN

LOC_DIAGNOSTIC_TYPE_BETTER_OPEN_GPS

LOC_DIAGNOSTIC_TYPE_BETTER_OPEN_WIFI

LOC_DIAGNOSTIC_TYPE_NEED_CHECK_NET

LOC_DIAGNOSTIC_TYPE_NEED_CHECK_LOC_PERMISSION

LOC_DIAGNOSTIC_TYPE_NEED_OPEN_PHONE_LOC_SWITCH

LOC_DIAGNOSTIC_TYPE_NEED_INSERT_SIMCARD_OR_OPEN_WIFI

LOC_DIAGNOSTIC_TYPE_NEED_CLOSE_FLYMODE

LOC_DIAGNOSTIC_TYPE_SERVER_FAIL

LOC_DIAGNOSTIC_TYPE_FAIL_UNKNOWN

Constructor Detail

LocationClient

LocationClient

Method Detail

getLocOption

setLocOption

updateLocation

requestNotifyLocation

requestOfflineLocation

requestLocation

isStarted

getLastKnownLocation

getVersion

restart

enableLocInForeground

disableLocInForeground

enableAssistantLocation

disableAssistantLocation

start

stop

registerNotify

removeNotifyEvent

registerNotifyLocationListener

registerLocationListener

unRegisterLocationListener

registerLocationListener

unRegisterLocationListener

startIndoorMode

stopIndoorMode

requestHotSpotState

getAccessKey

getBDLocationInCoorType

onReceiveLocation

onReceiveLightLocString