Class TencentLocationRequest

腾讯定位 SDK 定位请求类，用于配置单次定位和连续定位的各项参数。

基于鸿蒙系统的 SingleLocationRequest 和 ContinuousLocationRequest，提供统一的请求配置接口。

Author

Tencent Location Team

Since

1.0.0

Constructors

constructor

Properties

coordinateType requestLevel enableSensorForDirection firstLocationCachePolicy enableBackgroundLocation userActivityScenario? powerConsumptionScenario? interval innerInterval reverseGeocodeRequestInterval locatingPriority singleLocationTimeout

Methods

default setCoordinateType getCoordinateType setRequestLevel getRequestLevel setEnableSensorForDirection getEnableSensorForDirection getFirstLocationCachePolicy setFirstLocationCachePolicy setEnableBackgroundLocation getEnableBackgroundLocation setUserActivityScenario getUserActivityScenario setPowerConsumptionScenario getPowerConsumptionScenario setInterval getInterval setInnerInterval getInnerInterval setReverseGeocodeRequestInterval getReverseGeocodeRequestInterval setLocatingPriority getLocatingPriority setSingleLocationTimeout getSingleLocationTimeout toSystemContinuousLocationRequest toSystemSingleLocationRequest displayStringForCoordinateType displayStringForRequestLevel displayStringForUserActivityScenario displayStringForPowerConsumptionScenario displayStringForLocatingPriority displayStringFroSingleLocation displayStringForContinuousLocation toString

Constructors

Private constructor

  • new TencentLocationRequest(): TencentLocationRequest

  • 构造定位请求对象（私有构造函数，请使用 default() 静态方法创建实例）。

    Returns TencentLocationRequest

    Since

    1.0.0

Properties

Private coordinateType

coordinateType: any

坐标系类型，支持 WGS84 和 GCJ-02。

连续定位和单次定位都有效，默认值：GCJ-02

Since

1.0.0

Private requestLevel

requestLevel: any

定位请求级别，决定定位结果返回的数据详细程度。

连续定位和单次定位都有效，默认值：ADMIN_AREA

Since

1.0.0

Private enableSensorForDirection

enableSensorForDirection: any

是否启用传感器获取方向信息。开启后，通过 TencentLocation 中的 directionFromSensor 字段获取基于设备传感器的方向信息。

连续定位和单次定位都有效，默认值：false

Since

1.0.7

Private firstLocationCachePolicy

firstLocationCachePolicy: any

首个定位点的缓存策略。单位：秒。

  • -1：不使用缓存（默认值）
  • 0：使用缓存，但忽略缓存点的时间，即多老的缓存都要
  • 大于 0：使用缓存，但仅使用在此时间之内的缓存

版本说明：

  • 1.0.7：仅连续定位有效
  • 1.0.8+：连续定位和单次定位都生效

默认值：-1

Since

1.0.7

Private enableBackgroundLocation

enableBackgroundLocation: any

是否开启后台定位。开启后应用切换到后台仍可继续定位。

仅连续定位有效，默认值：false

Since

1.0.1

Private Optional userActivityScenario

userActivityScenario?: any

用户活动场景，与 powerConsumptionScenario 互斥。设置后将覆盖 powerConsumptionScenario 的配置。

仅连续定位有效，默认值：undefined

Since

1.0.0

Private Optional powerConsumptionScenario

powerConsumptionScenario?: any

功耗场景，与 userActivityScenario 互斥。设置后将覆盖 userActivityScenario 的配置。

仅连续定位有效，默认值：HIGH_POWER_CONSUMPTION

Since

1.0.0

Private interval

interval: any

腾讯连续定位回调间隔，由开发者监听。单位：秒。

仅连续定位有效，默认值：1

Since

1.0.0

Private innerInterval

innerInterval: any

系统连续定位回调间隔，由 SDK 内部监听。单位：秒。

仅连续定位有效，默认值：1

Since

1.0.0

Private reverseGeocodeRequestInterval

reverseGeocodeRequestInterval: any

连续定位时，逆地理编码请求的间隔。单位：秒。当 requestLevel 不为 GEO 时有效。

仅连续定位有效，默认值：10

Since

1.0.0

Private locatingPriority

locatingPriority: any

单次定位优先级，控制定位策略（精度优先或速度优先）。

仅单次定位有效，默认值：PRIORITY_LOCATING_SPEED

Since

1.0.0

Private singleLocationTimeout

singleLocationTimeout: any

单次定位超时时间。单位：秒，取值范围：≥ 1。

仅单次定位有效，默认值：5

Since

1.0.0

Methods

Static default

  • default(): TencentLocationRequest

  • 创建默认的定位请求实例。

    默认配置：

    • 坐标系：GCJ-02
    • 请求级别：ADMIN_AREA
    • 传感器方向：关闭
    • 首个定位点缓存策略：不使用缓存
    • 后台定位：关闭
    • 用户活动场景：undefined
    • 功耗场景：HIGH_POWER_CONSUMPTION
    • 腾讯回调间隔：1 秒
    • 系统回调间隔：1 秒
    • 逆地理编码间隔：10 秒
    • 单次定位优先级：PRIORITY_LOCATING_SPEED
    • 单次定位超时：5 秒

    Returns TencentLocationRequest

    默认配置的 TencentLocationRequest 实例

    Since

    1.0.0

setCoordinateType

  • setCoordinateType(coordinateType): TencentLocationRequest

  • 设置坐标系类型。

    连续定位和单次定位都有效，默认值：GCJ-02

    Parameters

    Returns TencentLocationRequest

    当前 TencentLocationRequest 实例，支持链式调用

    Since

    1.0.0

getCoordinateType

  • getCoordinateType(): CoordinateType

  • 获取坐标系类型。

    Returns CoordinateType

    当前配置的坐标系类型

    Since

    1.0.0

setRequestLevel

  • setRequestLevel(requestLevel): TencentLocationRequest

  • 设置定位请求级别，决定定位结果返回的数据详细程度。

    连续定位和单次定位都有效，默认值：ADMIN_AREA

    Parameters

    • requestLevel: RequestLevel

      定位请求级别（GEO、NAME、ADMIN_AREA、POI）

    Returns TencentLocationRequest

    当前 TencentLocationRequest 实例，支持链式调用

    Since

    1.0.0

getRequestLevel

  • getRequestLevel(): RequestLevel

  • 获取定位请求级别。

    Returns RequestLevel

    当前配置的定位请求级别

    Since

    1.0.0

setEnableSensorForDirection

  • setEnableSensorForDirection(enableSensorForDirection): TencentLocationRequest

  • 设置是否启用传感器获取方向信息。

    连续定位和单次定位都有效，默认值：false

    Parameters

    • enableSensorForDirection: boolean

      true 表示启用，false 表示禁用

    Returns TencentLocationRequest

    当前 TencentLocationRequest 实例，支持链式调用

    Since

    1.0.7

getEnableSensorForDirection

  • getEnableSensorForDirection(): boolean

  • 获取是否启用传感器获取方向信息。

    Returns boolean

    true 表示已启用，false 表示未启用

    Since

    1.0.7

getFirstLocationCachePolicy

  • getFirstLocationCachePolicy(): number

  • 获取首个定位点的缓存策略。

    Returns number

    缓存策略值（-1：不使用缓存；0：使用所有缓存；大于 0：使用指定时间内的缓存，单位：秒）

    Since

    1.0.7

    Note

    1.0.7 仅连续定位有效，1.0.8 起连续定位和单次定位都生效

setFirstLocationCachePolicy

  • setFirstLocationCachePolicy(firstLocationCachePolicy): TencentLocationRequest

  • 设置首个定位点的缓存策略。

    连续定位和单次定位都有效（1.0.8+），默认值：-1

    Parameters

    • firstLocationCachePolicy: number

      缓存策略值（-1：不使用缓存；0：使用所有缓存；大于 0：使用指定时间内的缓存，单位：秒）

    Returns TencentLocationRequest

    当前 TencentLocationRequest 实例，支持链式调用

    Since

    1.0.7

    Note

    1.0.7 仅连续定位有效，1.0.8 起连续定位和单次定位都生效

setEnableBackgroundLocation

  • setEnableBackgroundLocation(enableBackgroundLocation): TencentLocationRequest

  • 设置是否开启后台定位。

    仅连续定位有效，默认值：false

    Parameters

    • enableBackgroundLocation: boolean

      true 表示开启，false 表示关闭

    Returns TencentLocationRequest

    当前 TencentLocationRequest 实例，支持链式调用

    Since

    1.0.1

getEnableBackgroundLocation

  • getEnableBackgroundLocation(): boolean

  • 获取是否开启后台定位。

    Returns boolean

    true 表示已开启，false 表示未开启

    Since

    1.0.1

setUserActivityScenario

  • setUserActivityScenario(userActivityScenario): TencentLocationRequest

  • 设置用户活动场景。与 powerConsumptionScenario 互斥，设置后将清除 powerConsumptionScenario 的配置。

    仅连续定位有效，默认值：undefined

    Parameters

    • userActivityScenario: UserActivityScenario

      用户活动场景（NAVIGATION、SPORT、TRANSPORT、DAILY_LIFE_SERVICE）

    Returns TencentLocationRequest

    当前 TencentLocationRequest 实例，支持链式调用

    Since

    1.0.0

getUserActivityScenario

  • getUserActivityScenario(): UserActivityScenario

  • 获取用户活动场景。

    Returns UserActivityScenario

    当前配置的用户活动场景，如果未设置则返回 undefined

    Since

    1.0.0

setPowerConsumptionScenario

  • setPowerConsumptionScenario(powerConsumptionScenario): TencentLocationRequest

  • 设置功耗场景。与 userActivityScenario 互斥，设置后将清除 userActivityScenario 的配置。

    仅连续定位有效，默认值：HIGH_POWER_CONSUMPTION

    Parameters

    • powerConsumptionScenario: PowerConsumptionScenario

      功耗场景（HIGH_POWER_CONSUMPTION、LOW_POWER_CONSUMPTION、NO_POWER_CONSUMPTION）

    Returns TencentLocationRequest

    当前 TencentLocationRequest 实例，支持链式调用

    Since

    1.0.0

getPowerConsumptionScenario

setInterval

  • setInterval(interval): TencentLocationRequest

  • 设置腾讯连续定位回调间隔，由开发者监听。单位：秒。

    如果设置为 0，将同时将 innerInterval 设置为 0。小于 0 的值将被修正为 1。

    仅连续定位有效，默认值：1

    Parameters

    • interval: number

      回调间隔（秒）

    Returns TencentLocationRequest

    当前 TencentLocationRequest 实例，支持链式调用

    Since

    1.0.0

getInterval

  • getInterval(): number

  • 获取腾讯连续定位回调间隔。

    Returns number

    回调间隔（秒）

    Since

    1.0.0

setInnerInterval

  • setInnerInterval(innerInterval): TencentLocationRequest

  • 设置系统连续定位回调间隔，由 SDK 内部监听。单位：秒。

    如果设置为 0，将同时将 interval 设置为 0。小于 0 的值将被修正为 1。

    仅连续定位有效，默认值：1

    Parameters

    • innerInterval: number

      系统回调间隔（秒）

    Returns TencentLocationRequest

    当前 TencentLocationRequest 实例，支持链式调用

    Since

    1.0.0

getInnerInterval

  • getInnerInterval(): number

  • 获取系统连续定位回调间隔。

    Returns number

    系统回调间隔（秒）

    Since

    1.0.0

setReverseGeocodeRequestInterval

  • setReverseGeocodeRequestInterval(reverseGeocodeRequestInterval): TencentLocationRequest

  • 设置连续定位时，逆地理编码请求的间隔。单位：秒。仅当 requestLevel 不为 GEO 时有效。

    小于 1 的值将被修正为 1。

    仅连续定位有效，默认值：10

    Parameters

    • reverseGeocodeRequestInterval: number

      逆地理编码请求间隔（秒）

    Returns TencentLocationRequest

    当前 TencentLocationRequest 实例，支持链式调用

    Since

    1.0.0

getReverseGeocodeRequestInterval

  • getReverseGeocodeRequestInterval(): number

  • 获取连续定位时，逆地理编码请求的间隔。

    Returns number

    逆地理编码请求间隔（秒）

    Since

    1.0.0

setLocatingPriority

  • setLocatingPriority(locatingPriority): TencentLocationRequest

  • 设置单次定位优先级，控制定位策略（精度优先或速度优先）。

    仅单次定位有效，默认值：PRIORITY_LOCATING_SPEED

    Parameters

    • locatingPriority: LocatingPriority

      定位优先级（PRIORITY_ACCURACY、PRIORITY_LOCATING_SPEED）

    Returns TencentLocationRequest

    当前 TencentLocationRequest 实例，支持链式调用

    Since

    1.0.0

getLocatingPriority

  • getLocatingPriority(): LocatingPriority

  • 获取单次定位优先级。

    Returns LocatingPriority

    当前配置的定位优先级

    Since

    1.0.0

setSingleLocationTimeout

  • setSingleLocationTimeout(singleLocationTimeout): TencentLocationRequest

  • 设置单次定位超时时间。单位：秒，取值范围：≥ 1。

    小于 1 的值将被修正为 1。

    仅单次定位有效，默认值：5

    Parameters

    • singleLocationTimeout: number

      超时时间（秒）

    Returns TencentLocationRequest

    当前 TencentLocationRequest 实例，支持链式调用

    Since

    1.0.0

getSingleLocationTimeout

  • getSingleLocationTimeout(): number

  • 获取单次定位超时时间。

    Returns number

    超时时间（秒）

    Since

    1.0.0

toSystemContinuousLocationRequest

  • toSystemContinuousLocationRequest(): ContinuousLocationRequest

  • 将腾讯定位请求转换为鸿蒙系统的连续定位请求对象。

    SDK 内部使用。

    Returns ContinuousLocationRequest

    鸿蒙系统的 ContinuousLocationRequest 对象

    Since

    1.0.0

toSystemSingleLocationRequest

  • toSystemSingleLocationRequest(): SingleLocationRequest

  • 将腾讯定位请求转换为鸿蒙系统的单次定位请求对象。

    SDK 内部使用。

    Returns SingleLocationRequest

    鸿蒙系统的 SingleLocationRequest 对象

    Since

    1.0.0

displayStringForCoordinateType

  • displayStringForCoordinateType(): string

  • 获取坐标系类型的字符串表示。

    Returns string

    坐标系类型字符串（WGS84、GCJ02、UNKNOWN）

    Since

    1.0.0

displayStringForRequestLevel

  • displayStringForRequestLevel(): string

  • 获取请求级别的字符串表示。

    Returns string

    请求级别字符串（GEO、NAME、ADMIN_AREA、POI、UNKNOWN）

    Since

    1.0.0

displayStringForUserActivityScenario

  • displayStringForUserActivityScenario(): string

  • 获取用户活动场景的字符串表示。

    Returns string

    用户活动场景字符串（NAVIGATION、SPORT、TRANSPORT、DAILY_LIFE_SERVICE、UNKNOWN）

    Since

    1.0.0

displayStringForPowerConsumptionScenario

  • displayStringForPowerConsumptionScenario(): string

  • 获取功耗场景的字符串表示。

    Returns string

    功耗场景字符串（HIGH_POWER_CONSUMPTION、LOW_POWER_CONSUMPTION、NO_POWER_CONSUMPTION、UNKNOWN）

    Since

    1.0.0

displayStringForLocatingPriority

  • displayStringForLocatingPriority(): string

  • 获取定位优先级的字符串表示。

    Returns string

    定位优先级字符串（PRIORITY_ACCURACY、PRIORITY_LOCATING_SPEED、UNKNOWN）

    Since

    1.0.0

displayStringFroSingleLocation

  • displayStringFroSingleLocation(): string

  • 获取单次定位请求的字符串表示。

    Returns string

    单次定位请求的格式化字符串

    Since

    1.0.0

displayStringForContinuousLocation

  • displayStringForContinuousLocation(): string

  • 获取连续定位请求的字符串表示。

    Returns string

    连续定位请求的格式化字符串

    Since

    1.0.0

toString

  • toString(): string

  • 获取定位请求对象的完整字符串表示，包含所有配置参数。

    Returns string

    JSON 格式的字符串，包含所有定位请求配置

    Since

    1.0.0

Settings

Member Visibility

Theme

On This Page

constructorcoordinateTyperequestLevelenableSensorForDirectionfirstLocationCachePolicyenableBackgroundLocationuserActivityScenariopowerConsumptionScenariointervalinnerIntervalreverseGeocodeRequestIntervallocatingPrioritysingleLocationTimeoutdefaultsetCoordinateTypegetCoordinateTypesetRequestLevelgetRequestLevelsetEnableSensorForDirectiongetEnableSensorForDirectiongetFirstLocationCachePolicysetFirstLocationCachePolicysetEnableBackgroundLocationgetEnableBackgroundLocationsetUserActivityScenariogetUserActivityScenariosetPowerConsumptionScenariogetPowerConsumptionScenariosetIntervalgetIntervalsetInnerIntervalgetInnerIntervalsetReverseGeocodeRequestIntervalgetReverseGeocodeRequestIntervalsetLocatingPrioritygetLocatingPrioritysetSingleLocationTimeoutgetSingleLocationTimeouttoSystemContinuousLocationRequesttoSystemSingleLocationRequestdisplayStringForCoordinateTypedisplayStringForRequestLeveldisplayStringForUserActivityScenariodisplayStringForPowerConsumptionScenariodisplayStringForLocatingPrioritydisplayStringFroSingleLocationdisplayStringForContinuousLocationtoString