腾讯定位 SDK 的核心配置类,提供 SDK 初始化、隐私政策设置、日志控制和版本信息查询等功能。

Author

Tencent Location Team

Since

1.0.0

Constructors

Properties

context?: Context
apiKey?: string
deviceID?: string
extraData?: Map<string, string>
isPrivacyPolicyAgreed: boolean
needLogToFile: boolean

Methods

  • 初始化腾讯定位 SDK。

    Parameters

    • context: Context

      应用上下文,用于访问系统资源和服务。

    • Optional apiKey: string

      从腾讯位置服务控制台获取的 API 密钥。

    • Optional deviceID: string

      设备唯一标识符,建议使用 UUID,用于排查定位问题。

    • Optional extraData: Map<string, string>

      附加数据,可选的键值对映射。

    Returns void

    Example

    export default class EntryAbility extends UIAbility {
    onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
    TencentLocationSDK.init(this.context, 'YourApiKey', 'YourDeviceID')
    }
    }

    Since

    1.0.0

  • 设置用户是否同意隐私政策。

    为了适配合规要求,此方法应该是调用 SDK 的第一个接口,必须在用户同意隐私政策后才能使用其他 SDK 功能。

    Parameters

    • isPrivacyPolicyAgreed: boolean

      true 表示用户已同意隐私政策,false 表示用户未同意。

    Returns void

    Example

    // 在用户同意隐私政策后调用
    TencentLocationSDK.setPrivacyPolicyAgreement(true)

    Since

    1.0.0

  • 启用或禁用日志文件输出功能。

    Parameters

    • enableLogToFile: boolean

      true 表示启用日志文件输出,false 表示禁用。

    Returns void

    Since

    1.0.1

  • 获取 SDK 的版本号。

    Returns string

    SDK 版本号字符串。

    Example

    const sdkVersion = TencentLocationSDK.version()
    console.log(`SDK 版本: ${sdkVersion}`)
    // 输出: SDK 版本: 1.0.7

    Since

    1.0.7

  • 获取 SDK 的构建版本号。

    Returns string

    SDK 构建版本号字符串,格式为 yyyyMMdd。

    Example

    const buildVersion = TencentLocationSDK.buildVersion()
    console.log(`SDK 构建版本: ${buildVersion}`)
    // 输出: SDK 构建版本: 20251224

    Since

    1.0.7