RemoteLocationExtensionAbility（定位扩展Ability）-ArkTS API-Push Kit（推送服务）-应用服务

说明

定位扩展Ability目前为Beta阶段，暂未开放申请。

RemoteLocationExtensionAbility为定位扩展Ability，提供获取定位类场景化消息数据和生命周期销毁的回调。在用户授权后，定位扩展Ability可以查询用户的位置，并根据您的目的进行处理。定位扩展Ability有如下约束：

RemoteLocationExtensionAbility为独立子进程，轻量级，不允许唤醒主进程。
不允许调用通知API、卡片API。
生命周期根据场景受控，默认小于10秒，超过10秒子进程生命周期结束。

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.Push.PushService

起始版本：4.1.0(11)

导入模块

收起
自动换行
深色代码主题
复制
import { RemoteLocationExtensionAbility } from '@kit.PushKit';

属性

模型约束：属性仅可在Stage模型下使用。

系统能力：SystemCapability.Push.PushService

起始版本：4.1.0(11)

展开

名称	类型	只读	可选	说明
context	RemoteLocationExtensionContext	否	否	RemoteLocationExtensionAbility的上下文环境，继承自ExtensionContext。

onReceiveMessage

onReceiveMessage(payload: pushCommon.PushPayload): Promise<void>

应用先继承RemoteLocationExtensionAbility后接收场景化消息的接口，使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.Push.PushService

起始版本：4.1.0(11)

参数：

展开

参数名	类型	可选	说明
payload	pushCommon.PushPayload	否	场景化消息数据。

返回值：

展开

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。。

示例：

收起
自动换行
深色代码主题
复制
import { RemoteLocationExtensionAbility, pushCommon } from '@kit.PushKit'; 
import { hilog } from '@kit.PerformanceAnalysisKit'; 
 
// 此处以TestExtAbility继承RemoteLocationExtensionAbility为例 
export default class TestExtAbility extends RemoteLocationExtensionAbility { 
  async onReceiveMessage(payload: pushCommon.PushPayload): Promise<void> { 
    hilog.info(0x0000, 'testTag', 'TestExtAbility onReceiveMessage, payload : %{public}s', JSON.stringify(payload)); 
  } 
}

onDestroy

onDestroy(): void

当RemoteLocationExtensionAbility生命周期结束时，会执行该回调，建议在该方法中执行资源清理等操作。

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.Push.PushService

起始版本：4.1.0(11)

示例：

收起
自动换行
深色代码主题
复制
import { RemoteLocationExtensionAbility } from '@kit.PushKit'; 
import { hilog } from '@kit.PerformanceAnalysisKit'; 
 
// 此处以TestExtAbility继承RemoteLocationExtensionAbility为例 
export default class TestExtAbility extends RemoteLocationExtensionAbility { 
  onDestroy(): void { 
    hilog.info(0x0000, 'testTag', 'TestExtAbility onDestroy'); 
  } 
}