# 扩展 SDK

扩展SDK 是对核心SDK的补充，所以要使用扩展SDK，也必须依赖核心SDK。

为了保证 SDK 的安全稳定性，将需要权限的API尽可能放到扩展SDK，FinClip 将 SDK 拆分为核心 SDK 与扩展 SDK，后者是前者的补充，因此使用扩展 SDK 也必须依赖核心 SDK。

一些涉及到权限的api，我们将其拆分到各个扩展SDK，您可以根据实际情况集成相应的扩展SDK。

请注意

注意：使用扩展SDK需要保证与核心SDK版本号保持一致，避免出现未知问题

请注意

注意：从 1.3.3 开始，为了使 SDK 合规，各个扩展 SDK 都声明了对应的权限。如果证书没有相关权限，集成时会报错。

# 1 蓝牙扩展SDK

@finclip/bluetooth-sdk是蓝牙扩展SDK。

涉及到的权限：ohos.permission.ACCESS_BLUETOOTH

# 1.1 集成蓝牙扩展SDK

在 dependencies 添加 @finclip/bluetooth-sdk

  "dependencies": {
    "@finclip/sdk": "latest",
    "@finclip/bluetooth-sdk": "latest"
  }

# 1.2 注册蓝牙扩展SDK

import { FinAppletBluetooth } from '@finclip/bluetooth-sdk';
// BluetoothSDK初始化
FinAppletBluetooth.init()

# 1.3 蓝牙SDK相关api概览

api名称	api描述信息
蓝牙-通用	一系列的api
蓝牙-低功耗中心设备	一系列的api
蓝牙-信标	鸿蒙系统不支持

# 2 通讯录扩展SDK

@finclip/contact-sdk是通讯录扩展SDK。

涉及到的权限：ohos.permission.WRITE_CONTACTS、ohos.permission.READ_CONTACTS

# 2.1 集成通讯录扩展SDK

在 dependencies 添加 @finclip/contact-sdk

  "dependencies": {
    "@finclip/sdk": "latest",
    "@finclip/contact-sdk": "latest"
  }

# 2.2 注册通讯录扩展SDK

import { FinAppletContact } from '@finclip/contact-sdk';
// ContactSDK初始化
FinAppletContact.init()

# 2.3 通讯录SDK相关api概览

api名称	api描述信息
addPhoneContact	添加手机通讯录联系人。
chooseContact	拉起手机通讯录，选择联系人。

# 3 剪贴板扩展SDK

@finclip/clipboard-sdk是剪贴板扩展SDK。

涉及到的权限：ohos.permission.READ_PASTEBOARD

# 3.1 集成剪贴板扩展SDK

在 dependencies 添加 @finclip/clipboard-sdk

  "dependencies": {
    "@finclip/sdk": "latest",
    "@finclip/clipboard-sdk": "latest"
  }

# 3.2 注册剪贴板扩展SDK

import { FinAppletClipboard } from '@finclip/clipboard-sdk';
// ClipboardSDK初始化
FinAppletClipboard.init()

注意

由于剪贴板权限比较敏感，且api比较冷门。您也可以通过注册自定义api的方式添加剪贴板相关的两个api。

注入的源码如下：

import { AbstractAPIManager, FinAppClient, IApiManager, PermissionHelper } from '@finclip/sdk-core';
import { pasteboard } from '@kit.BasicServicesKit';

namespace IClipboardAPI {
  export interface IClipboardData {
    data: string
  }
}

function getClipboardData(args: IApiManager.IInvokeArgs, apiManager: AbstractAPIManager) {
  const callback = args.callback
  const context = apiManager.UIContext
  PermissionHelper.requestPermissions(context, ['ohos.permission.READ_PASTEBOARD'], () => {
    const systemPasteboard = pasteboard.getSystemPasteboard();
    systemPasteboard.getData().then((pasteData) => {
      const text = pasteData.getPrimaryText();
      const res: IApiManager.IInvokeBaseResponse = {
        errMsg: 'getClipboardData:ok',
        data: text
      }
      callback.onSuccess(res)
    }).catch((err: Error) => {
      callback.onFail({ errMsg: err.message })
    });
  }, (index: number) => {
    // 用户拒绝授权
    callback.onFail({ errMsg: PermissionHelper.authDenyMsg })
  })
}


function setClipboardData(args: IApiManager.IInvokeArgs, apiManager: AbstractAPIManager) {
  const callback = args.callback
  const params = args.params as IClipboardAPI.IClipboardData
  const text: string = params.data
  const pasteData: pasteboard.PasteData = pasteboard.createData(pasteboard.MIMETYPE_TEXT_PLAIN, text);
  const systemPasteboard: pasteboard.SystemPasteboard = pasteboard.getSystemPasteboard();
  const res: IApiManager.IInvokeBaseResponse = {
    errMsg: 'setClipboardData:ok'
  }
  systemPasteboard.setData(pasteData).then(() => {
    callback.onSuccess(res)
  }).catch((err: Error) => {
    callback.onFail({ errMsg: err.message })
  });
}

FinAppClient.getInstance()?.registerCustomApi('getClipboardData', getClipboardData)
FinAppClient.getInstance()?.registerCustomApi('setClipboardData', setClipboardData)

# 3.3 剪贴板SDK相关api概览

api名称	api描述信息
setClipboardData	设置剪贴板内容
getClipboardData	获取剪贴板内容

# 4 日历扩展SDK

@finclip/calendar-sdk是日历扩展SDK。

涉及到的权限：ohos.permission.READ_CALENDAR、ohos.permission.WRITE_CALENDAR

# 4.1 集成日历扩展SDK

在 dependencies 添加 @finclip/calendar-sdk

  "dependencies": {
    "@finclip/sdk": "latest",
    "@finclip/calendar-sdk": "latest"
  }

# 4.2 注册日历扩展SDK

import { FinAppletCalendar } from '@finclip/calendar-sdk';
// CalendarSDK初始化
FinAppletCalendar.init()

# 4.3 日历SDK相关api概览

api名称	api描述信息
addPhoneCalendar	添加日历普通事件
addPhoneRepeatCalendar	添加日历重复事件

# 5 百度地图扩展SDK

@finclip/baidu-map-sdk是百度地图扩展SDK。

百度地图使用准备请参考文档：百度地图 (opens new window)

涉及到的权限：ohos.permission.LOCATION、ohos.permission.LOCATION_IN_BACKGROUND、ohos.permission.APPROXIMATELY_LOCATION、

# 5.1 集成百度地图扩展SDK

在 dependencies 添加 @finclip/baidu-map-sdk

  "dependencies": {
    "@finclip/sdk": "latest",
    "@finclip/baidu-map-sdk": "latest"
  }

# 5.2 注册百度地图扩展SDK

# 5.2.1 简单使用

import { FinAppletBaiduMap } from '@finclip/baidu-map-sdk';

// 会初始化百度地图 SDK 和注册地图组件
FinAppletBaiduMap.init('api_key')  // 传入在开放平台申请的 API key

# 5.2.2 只注册组件

import { FinAppletBaiduMap } from '@finclip/baidu-map-sdk';

// 如果项目中已初始化过百度地图，可以只注册地图组件
FinAppletBaiduMap.registerComponent()

# 5.3 修改坐标系

地图 SDK 提供的 CoordType 是从 @bdmap/base 内导出的，具体定义可以参考百度地图文档 (opens new window)

import { FinAppletBaiduMap, CoordType } from '@finclip/baidu-map-sdk';

// 可以使用API修改百度地图坐标系
FinAppletBaiduMap.setBDMapCoordinateType(CoordType.GCJ02)

# 5.4 百度地图SDK相关api概览

api名称	api描述信息
Map组件	视图组件
MapContext	一系列的api
openLocation	查看位置
chooseLocation	选择位置
choosePoi	打开POI列表选择位置

# 6 相册扩展SDK

@finclip/album-sdk是相册扩展SDK。

涉及到的权限：ohos.permission.WRITE_IMAGEVIDEO

# 6.1 集成相册扩展SDK

在 dependencies 添加 @finclip/album-sdk

  "dependencies": {
    "@finclip/sdk": "latest",
    "@finclip/album-sdk": "latest"
  }

# 6.2 注册相册扩展SDK

import { FinAppletAlbum } from '@finclip/album-sdk';
// AlbumSDK初始化
FinAppletAlbum.init()

# 6.3 相册SDK相关api概览

注意

相册扩展SDK使用 ACL 权限实现了 ACLPermissionHandler.saveMediaToPhotosAlbum，如果已自行实现了该代理方法请不要使用该 SDK，会覆盖实现