functionalButtonComponentManager(场景化融合Button组件管理)

导入模块

import { functionalButtonComponentManager } from '@kit.ScenarioFusionKit';

OpenType

该枚举定义了FunctionalButton组件的功能类型，通过设置该参数来指定FunctionalButton的功能。

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

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

SizeType

该枚举定义了FunctionalButton的尺寸类型。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

HoverClassType

该枚举定义了FunctionalButton点击态的类型。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

ColorType

该枚举定义了FunctionalButton的颜色类型。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

CredentialType^(deprecated)

该枚举定义了FunctionalButton的认证类型。

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

元服务API： 从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 5.0.0(12)

RealNameAuthenticationInfo^(deprecated)

该接口定义了FunctionalButton组件的实名信息校验对象。

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

元服务API： 从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 5.0.0(12)

StyleOption

该接口定义了FunctionalButton组件的样式信息。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

FunctionalButtonParams

该接口定义了FunctionalButton组件的参数，定义Button功能以及样式等。

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

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

GetPhoneNumberResult

该接口定义了使用快速验证功能成功验证的响应。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1、TV中可正常调用，在其他设备类型中返回801错误码。

起始版本： 4.1.0(11)

GetRealtimePhoneNumberResult

该接口定义了使用实时验证功能成功验证的响应。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1、TV中可正常调用，在其他设备类型中返回801错误码。

起始版本： 4.1.0(11)

OpenSettingResult

该接口定义了使用打开授权设置页功能，成功跳转授权设置页后返回应用或结束设置应用，应用权限设置情况的响应。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1、TV中可正常调用，在其他设备类型中返回801错误码。

起始版本： 4.1.0(11)

ChooseAvatarResult

该接口定义了使用选择头像功能成功选择的响应。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1中可正常调用，在其他设备类型中返回801错误码。

起始版本： 4.1.0(11)

AppParam

该接口定义了FunctionalButton为打开APP功能时，通过该参数指定打开的应用对应的包名和Ability名称。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1、TV中可正常调用，在其他设备类型中返回801错误码。

起始版本： 4.1.0(11)

ChooseAddressResult

该接口定义了FunctionalButton为选择收货地址功能时，通过该参数指定选择收货地址对应的返回体。

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

元服务API： 从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1、TV中可正常调用，在其他设备类型中返回801错误码。

起始版本： 5.0.0(12)

ChooseInvoiceTitleResult

该接口定义了FunctionalButton为选择发票抬头功能时，通过该参数指定选择发票抬头对应的返回体。

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

元服务API： 从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1中可正常调用，在其他设备类型中返回801错误码。

起始版本： 5.0.0(12)

RealNameAuthenticationResult

该接口定义了FunctionalButton为实名信息校验功能时，通过该参数指定实名信息校验对应的返回体。

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

元服务API： 从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet中可正常调用，在PC/2in1中返回1001500003错误码，在TV中返回801错误码。

起始版本： 5.0.0(12)

FaceAuthenticationResult

该接口定义了FunctionalButton为人脸核身功能时，通过该参数指定人脸认证对应的返回体。

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

元服务API： 从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet中可正常调用，在PC/2in1中返回1001500003错误码，在TV中返回801错误码。

起始版本： 5.0.0(12)

FaceVerificationResult

该接口定义了FunctionalButton为人脸核身功能时，通过该参数指定人脸核身对应的返回体。

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

元服务API： 从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet中可正常调用，在PC/2in1中返回1001500003错误码，在TV中返回801错误码。

起始版本： 5.0.0(12)

ChooseLocationResult

该接口定义了FunctionalButton为地图选点功能时，通过该参数指定地图选点对应的返回体。

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

元服务API： 从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1中可正常调用，在其他设备类型中返回801错误码。

起始版本： 5.0.0(12)

SubscribeLiveViewParam

该接口定义了FunctionalButton组件为实况窗订阅功能时，通过该参数指定实况窗订阅对应的订阅事件和计时器。

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

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet中可正常调用，在其他设备类型中返回801错误码。

起始版本： 5.0.0(12)

SubscribeLiveViewResult

该接口定义了FunctionalButton组件为实况窗订阅功能时，通过该参数指定实况窗订阅对应的返回体。

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

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet中可正常调用，在其他设备类型中返回801错误码。

起始版本： 5.0.0(12)

PermissionSettingResult

该接口定义了FunctionalButton组件为权限设置功能时，通过该参数指定权限设置的返回体，用于UIAbility/UIExtensionAbility二次拉起权限设置弹框。

在调用此接口前，应用需要先调用requestPermissionsFromUser，如果用户在首次弹窗授权时已授权，调用当前接口将无法拉起弹窗。

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

元服务API： 从版本5.0.2(14)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1、TV中可正常调用，在其他设备类型中返回801错误码。

起始版本： 5.0.2(14)

RequestSubscribeMessageResult

该接口定义请求订阅消息的返回体。

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

元服务API： 从版本6.0.0(20)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1中可正常调用，在其他设备类型中返回801错误码。

起始版本： 6.0.0(20)

ShareParam

该接口定义分享的参数。

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

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1中可正常调用，在其他设备类型中返回801错误码。

起始版本： 6.0.0(20)

GetPhoneNumberAndRiskLevelResult

该接口定义获取手机号和风险等级的返回体。

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

元服务API： 从版本6.0.2(22)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 6.0.2(22)

事件

不支持通用事件，仅支持以下事件：

FunctionalButtonController

FunctionalButton组件控制器，用来回调组件内部的点击事件。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

onGetPhoneNumber

onGetPhoneNumber(callback: AsyncCallback<GetPhoneNumberResult>): FunctionalButtonController

注册FunctionalButton组件为快速验证手机号的点击事件，使用callback异步回调。

该接口功能依赖Account Kit，参见createAuthorizationWithHuaweiIDRequest。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1、TV中可正常调用，在其他设备类型中返回801错误码。

起始版本： 4.1.0(11)

参数：

返回值：

示例：

import { FunctionalButton, functionalButtonComponentManager } from '@kit.ScenarioFusionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

@Entry
@Component
struct Index {
  build() {
    Row() {
      Column() {
        // 构建FunctionalButton组件实例。
        FunctionalButton({
          params: {
            // OpenType.GET_PHONE_NUMBER表示该按钮用于快速验证手机号码。
            openType: functionalButtonComponentManager.OpenType.GET_PHONE_NUMBER,
            label: '快速验证手机号',
            // 调整按钮样式。
            styleOption: {
              styleConfig: new functionalButtonComponentManager.ButtonConfig()
                .fontSize(20)
            }
          },
          // 当OpenType为GET_PHONE_NUMBER时，回调必须为onGetPhoneNumber。
          controller: new functionalButtonComponentManager.FunctionalButtonController()
            .onGetPhoneNumber((err, data) => {
              if (err) {
                // 错误日志处理。
                hilog.error(0x0000, 'testTag', 'Failed to authenticate, error: %{public}d %{public}s', err.code, err.message);
                return;
              }
              // 成功日志处理。
              hilog.info(0x0000, 'testTag', 'succeeded in authenticating');
              // 获取授权码。
              let authorizationCode = data.code;
            })
        })
      }.width('100%')
    }.height('100%')
  }
}

onGetRealtimePhoneNumber

onGetRealtimePhoneNumber(callback: AsyncCallback<GetRealtimePhoneNumberResult>): FunctionalButtonController

注册FunctionalButton组件为实时验证手机号的点击事件，使用callback异步回调。

该接口功能依赖Account Kit，参见createAuthorizationWithHuaweiIDRequest。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1、TV中可正常调用，在其他设备类型中返回801错误码。

起始版本： 4.1.0(11)

参数：

返回值：

示例：

import {FunctionalButton, functionalButtonComponentManager} from '@kit.ScenarioFusionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

@Entry
@Component
struct Index {
  build() {
    Row() {
      Column() {
        // 构建FunctionalButton组件实例。
        FunctionalButton({
          params: {
            // OpenType.GET_REALTIME_PHONENUMBER表示该按钮用于实时验证手机号码。
            openType: functionalButtonComponentManager.OpenType.GET_REALTIME_PHONENUMBER,
            label: '实时验证手机号',
            // 调整按钮样式。
            styleOption: {
              styleConfig: new functionalButtonComponentManager.ButtonConfig()
                .fontSize(20)
            }
          },
          // 当OpenType为GET_REALTIME_PHONENUMBER时，回调必须为onGetRealtimePhoneNumber。
          controller: new functionalButtonComponentManager.FunctionalButtonController()
            .onGetRealtimePhoneNumber((err, data) => {
              if (err) {
                // 错误日志处理。
                hilog.error(0x0000, 'testTag', 'Failed to authenticate, error: %{public}d %{public}s', err.code, err.message);
                return;
              }
              // 成功日志处理。
              hilog.info(0x0000, 'testTag', 'succeeded in authenticating');
              // 获取授权码。
              let authorizationCode = data.code;
            })
        })
      }
      .width('100%')
    }
    .height('100%')
  }
}

onLaunchApp

onLaunchApp(callback: AsyncCallback<void>): FunctionalButtonController

注册FunctionalButton组件为打开APP的点击事件，使用callback异步回调。

该接口功能依赖Ability Kit，参见startAbility。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1、TV中可正常调用，在其他设备类型中返回801错误码。

起始版本： 4.1.0(11)

参数：

返回值：

示例：

import { FunctionalButton, functionalButtonComponentManager } from '@kit.ScenarioFusionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

@Entry
@Component
struct Index {
  build() {
    Row() {
      Column() {
        // 构建FunctionalButton组件实例。
        FunctionalButton({
          params: {
            // OpenType.LAUNCH_APP表示该按钮用于启动应用。
            openType: functionalButtonComponentManager.OpenType.LAUNCH_APP,
            label: '打开APP',
            // 当OpenType为functionalButtonComponentManager.OpenType.LAUNCH_APP时，appParam为必填项。
            appParam: {
              bundleName: 'xxx',
              abilityName: 'xxx'
            },
            // 调整按钮样式。
            styleOption: {
              styleConfig: new functionalButtonComponentManager.ButtonConfig()
                .fontSize(20)
            }
          },
          // 当OpenType设置为LAUNCH_APP时，回调函数必须是onLaunchApp。
          controller: new functionalButtonComponentManager.FunctionalButtonController().onLaunchApp((err) => {
            if (err) {
              // 错误日志处理。
              hilog.error(0x0000, 'testTag', 'Failed to launch app, error: %{public}d %{public}s', err.code, err.message);
              return;
            }
            // 处理成功。成功时不会返回任何值。
            hilog.info(0x0000, 'testTag', 'succeeded in launching app');
          })
        })
      }.width('100%')
    }.height('100%')
  }
}

onOpenSetting

onOpenSetting(callback: AsyncCallback<OpenSettingResult>): FunctionalButtonController

注册FunctionalButton组件为打开授权设置页的点击事件，使用callback异步回调。

该接口功能依赖Ability Kit，参见startAbilityForResult。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1、TV中可正常调用，在其他设备类型中返回801错误码。

起始版本： 4.1.0(11)

参数：

返回值：

示例：

import { FunctionalButton, functionalButtonComponentManager } from '@kit.ScenarioFusionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

@Entry
@Component
struct Index {
  build() {
    Row() {
      Column() {
        // 构建FunctionalButton组件实例。
        FunctionalButton({
          params: {
            // OpenType.OPEN_SETTING表示该按钮用于打开授权设置页面。
            openType: functionalButtonComponentManager.OpenType.OPEN_SETTING,
            label: '打开授权设置页',
            // 调整按钮样式。
            styleOption: {
              styleConfig: new functionalButtonComponentManager.ButtonConfig()
                .fontSize(20)
            }
          },
          // 当OpenType为OPEN_SETTING时，回调必须为onOpenSetting。
          controller: new functionalButtonComponentManager.FunctionalButtonController().onOpenSetting((err, data) => {
            if (err) {
              // 错误日志处理。
              hilog.error(0x0000, 'testTag', 'Failed to open setting, error: %{public}d %{public}s', err.code, err.message);
              return;
            }
            // 成功处理，当应用程序进程停止时触发。
            hilog.info(0x0000, 'testTag', 'succeeded in opening setting');
            data.permissions!.forEach((value, key) => {
              hilog.info(0x0000, 'testTag', 'key: %{public}s value: %{public}s', String(key), value);
            });
          })
        })
      }.width('100%')
    }.height('100%')
  }
}

onChooseAvatar

onChooseAvatar(callback: AsyncCallback<ChooseAvatarResult>): FunctionalButtonController

注册FunctionalButton组件为选择头像的点击事件，使用callback异步回调。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1中可正常调用，在其他设备类型中返回801错误码。

起始版本： 4.1.0(11)

参数：

返回值：

示例：

import { FunctionalButton, functionalButtonComponentManager } from '@kit.ScenarioFusionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

@Entry
@Component
struct Index {
  // 将account.png文件添加到/resources/base/media/目录中。否则，将显示错误信息，提示找不到该文件。
  @State url: ResourceStr = $r('app.media.account');

  build() {
    Column() {
      // 构建FunctionalButton组件实例。
      FunctionalButton({
        params: {
          // OpenType.CHOOSE_AVATAR表示该按钮用于选择头像。
          openType: functionalButtonComponentManager.OpenType.CHOOSE_AVATAR,
          label: '',
          // 调整按钮样式。
          styleOption: {
            styleConfig: new functionalButtonComponentManager.ButtonConfig()
              .type(ButtonType.Normal)
              .backgroundImage(this.url)
              .backgroundImageSize(ImageSize.Cover)
              .width(80)
              .height(80)
              .backgroundColor('#E5E5E5')
          }
        },
        // 当OpenType设置为CHOOSE_AVATAR时，回调函数必须是onChooseAvatar。
        controller: new functionalButtonComponentManager.FunctionalButtonController().onChooseAvatar((err, data) => {
          if (err) {
            // 错误日志处理。
            hilog.error(0x0000, 'testTag', 'Failed to choose avatar, error: %{public}d %{public}s', err.code, err.message);
            return;
          }
          // 成功日志处理。
          hilog.info(0x0000, 'testTag', 'succeeded in choosing avatar');
          this.url = data.avatarUri!;
        })
      })
    }
    .padding({ top: 200 })
    .height('100%')
    .width('100%')
  }
}

onChooseAddress

onChooseAddress(callback: AsyncCallback<ChooseAddressResult>): FunctionalButtonController

注册FunctionalButton组件为选择收货地址的点击事件，使用callback异步回调。

该接口功能依赖Account Kit，参见chooseAddress。

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

元服务API： 从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1、TV中可正常调用，在其他设备类型中返回801错误码。

起始版本： 5.0.0(12)

参数：

返回值：

示例：

import { FunctionalButton, functionalButtonComponentManager } from '@kit.ScenarioFusionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

@Entry
@Component
struct Index {
  build() {
    Row() {
      Column() {
        // 构建FunctionalButton组件实例。
        FunctionalButton({
          params: {
            // OpenType.CHOOSE_ADDRESS表示该按钮用于选择收货地址。
            openType: functionalButtonComponentManager.OpenType.CHOOSE_ADDRESS,
            label: '选择收货地址',
            // 调整按钮样式。
            styleOption: {
              bgColor:functionalButtonComponentManager.ColorType.DEFAULT,
              size: functionalButtonComponentManager.SizeType.DEFAULT,
              plain: false,
              disabled:false,
              loading: false,
              hoverClass: functionalButtonComponentManager.HoverClassType.HOVER_CLASS,
              hoverStartTime: 0,
              hoverStayTime: 0,
              styleConfig: new functionalButtonComponentManager.ButtonConfig()
                .fontSize(20)
            }
          },
          // 当OpenType设置为CHOOSE_ADDRESS时，回调必须为onChooseAddress。
          controller: new functionalButtonComponentManager.FunctionalButtonController()
            .onChooseAddress((err, data) => {
              if (err) {
                // 错误日志处理。
                hilog.error(0x0000, 'testTag', 'Failed to choose address, error: %{public}d %{public}s', err.code, err.message);
                return;
              }
              // 成功日志处理。
              hilog.info(0x0000, 'testTag', 'succeeded in choosing address');
              // 获取地址信息。
              let userName: string = data.userName;
              let mobileNumber: string = data.mobileNumber as string;
              let countryCode: string = data.countryCode as string;
              let provinceName: string = data.provinceName as string;
              let cityName: string = data.cityName as string;
              let districtName: string = data.districtName as string;
              let streetName: string = data.streetName as string;
              let detailedAddress: string = data.detailedAddress;
            })
        })
      }.width('100%')
    }.height('100%')
  }
}

onChooseInvoiceTitle

onChooseInvoiceTitle(callback: AsyncCallback<ChooseInvoiceTitleResult>): FunctionalButtonController

注册FunctionalButton组件为选择发票抬头的点击事件，使用callback异步回调。

该接口功能依赖Account Kit，参见selectInvoiceTitle。

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

元服务API： 从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1中可正常调用，在其他设备类型中返回801错误码。

起始版本： 5.0.0(12)

参数：

返回值：

示例：

import { FunctionalButton, functionalButtonComponentManager } from '@kit.ScenarioFusionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

@Entry
@Component
struct Index {
  build() {
    Row() {
      Column() {
        // 构建FunctionalButton组件实例。
        FunctionalButton({
          params: {
            // OpenType.CHOOSE_INVOICE_TITLE表示该按钮用于选择发票抬头。
            openType: functionalButtonComponentManager.OpenType.CHOOSE_INVOICE_TITLE,
            label: '选择发票抬头',
            // 调整按钮样式。
            styleOption: {
              bgColor:functionalButtonComponentManager.ColorType.DEFAULT,
              size: functionalButtonComponentManager.SizeType.DEFAULT,
              plain: false,
              disabled:false,
              loading: false,
              hoverClass: functionalButtonComponentManager.HoverClassType.HOVER_CLASS,
              hoverStartTime: 0,
              hoverStayTime: 0,
              styleConfig: new functionalButtonComponentManager.ButtonConfig()
                .fontSize(20)
            }
          },
          // 当OpenType为CHOOSE_INVOICE_TITLE时，回调必须为onChooseInvoiceTitle。
          controller: new functionalButtonComponentManager.FunctionalButtonController()
            .onChooseInvoiceTitle((err, data) => {
              if (err) {
                // 错误日志处理。
                hilog.error(0x0000, 'testTag', 'Failed to obtain invoice title, error: %{public}d %{public}s', err.code, err.message);
                return;
              }
              // 成功日志处理。
              hilog.info(0x0000, 'testTag', 'succeeded in obtaining invoice title');
              // 获取发票信息。
              let type: string = data.type;
              let title: string = data.title;
              let taxNumber: string = data.taxNumber;
              let companyAddress: string | undefined = data.companyAddress;
              let telephone: string | undefined = data.telephone;
              let bankName: string | undefined = data.bankName;
              let bankAccount: string | undefined = data.bankAccount;
            })
        })
      }.width('100%')
    }.height('100%')
  }
}

onRealNameAuthentication

onRealNameAuthentication(callback: AsyncCallback<RealNameAuthenticationResult>): FunctionalButtonController

注册FunctionalButton组件为实名信息校验的点击事件，使用callback异步回调。

该接口功能依赖Account Kit，参见createAuthorizationWithHuaweiIDRequest，AuthenticationController，executeRequest。

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

元服务API： 从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet中可正常调用，在PC/2in1中返回1001500003错误码，在TV中返回801错误码。

起始版本： 5.0.0(12)

参数：

返回值：

示例：

import { FunctionalButton, functionalButtonComponentManager } from '@kit.ScenarioFusionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { http } from '@kit.NetworkKit';
import { AsyncCallback, BusinessError } from '@kit.BasicServicesKit';

interface Result {
  state?: number;
  realNameLevel?: number;
  verifyResult?: number;
  verifyToken?: string;
}

@Entry
@Component
struct SecondPage {

  obtainRealNameDataInfo(authCode: string, sceneID: number, openID: string, realName: string, idNo: string,
    callback: AsyncCallback<Result>) {
    // 每个httpRequest对应一个HTTP请求任务，且不可重复使用。
    let httpRequest = http.createHttp();
    // 监听HTTP响应头事件，该事件比HTTP请求的响应返回得更早。是否监听HTTP响应头事件由您决定。
    httpRequest.on('headersReceive', (header) => {
      hilog.info(0x0000, 'testTag', 'header: %{public}s', header as string);
    });
    httpRequest.request(
      // 请自行在extraData中自定义EXAMPLE_URL。是否向URL添加参数由您决定。
      'EXAMPLE_URL',
      {
        method: http.RequestMethod.POST,
        // 您可以根据服务需求添加头部字段。
        header: {
          'Content-Type': 'application/json'
        },
        // 使用此字段在POST请求中传递信息。
        extraData: {
          'authCode': authCode,
          'sceneID': sceneID,
          'openID': openID,
          'realname': realName,
          'idNo': idNo
        },
        expectDataType: http.HttpDataType.STRING,
        usingCache: true,
        priority: 1,
        connectTimeout: 60000,
        readTimeout: 60000,
        usingProtocol: http.HttpProtocol.HTTP1_1
      }, (err, data) => {
      if (!err) {
        let res: Result = JSON.parse(data.result as string);
        callback(undefined, res);
      } else {
        let error: BusinessError = {code: err.code, message: err.message, name: ''};
        callback(error, undefined);
        // 取消订阅HTTP响应头事件。
        httpRequest.off('headersReceive');
        // 在httpRequest完成后调用destroy()方法以释放资源。
        httpRequest.destroy();
      }
    });
  }

  build() {
    Row() {
      Column() {
        FunctionalButton({
          params: {
            // OpenType.REAL_NAME_AUTHENTICATION表示该按钮用于实名信息校验。
            openType: functionalButtonComponentManager.OpenType.REAL_NAME_AUTHENTICATION,
            label: '实名信息校验',
            // 调整按钮样式。
            styleOption: {
              styleConfig: new functionalButtonComponentManager.ButtonConfig()
                .fontSize(20)
            }
          },
          // 当OpenType设置为REAL_NAME_AUTHENTICATION时，回调必须为onRealNameAuthentication。
          controller: new functionalButtonComponentManager.FunctionalButtonController()
            .onRealNameAuthentication((err, data) => {
              if (err) {
                // 错误日志处理。
                hilog.error(0x0000, 'testTag', 'Failed to authenticate, error: %{public}d %{public}s', err.code, err.message);
                return;
              }
              // 成功日志处理。
              hilog.info(0x0000, 'testTag', 'succeeded in authenticating');
              // 获取授权码。
              let authCode: string = data.authCode as string;
              let openID: string = data.openID as string;
              // sceneid 表示场景ID。选项包括：0（实名验证）、1（人脸验证，验证姓名、证件类型、证件号码和人脸）和2（人脸验证，仅验证人脸）。
              this.obtainRealNameDataInfo(authCode, 0, openID, 'name', 'idNo', (err, data) => {
                if (err) {
                  hilog.error(0x0000, 'testTag', 'Failed to verify, error: %{public}d %{public}s', err.code, err.message);
                  return;
                }
                let state = data.state;
                let realNameLevel = data.realNameLevel;
                let verifyResult = data.verifyResult;
                let verifyToken = data.verifyToken;
                hilog.info(0x0000, 'testTag', 'succeeded in verifying');
              });
            })
        })
      }
      .width('100%')
    }
    .height('100%')
  }
}

onFaceAuthentication

onFaceAuthentication(callback: AsyncCallback<FaceAuthenticationResult>): FunctionalButtonController

注册FunctionalButton组件为人脸核身的点击事件，使用callback异步回调。

该接口功能依赖Account Kit，参见createAuthorizationWithHuaweiIDRequest，AuthenticationController，executeRequest。

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

元服务API： 从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet中可正常调用，在PC/2in1中返回1001500003错误码，在TV中返回801错误码。

起始版本： 5.0.0(12)

参数：

返回值：

示例：

import { FunctionalButton, functionalButtonComponentManager } from '@kit.ScenarioFusionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { http } from '@kit.NetworkKit';
import { AsyncCallback, BusinessError } from '@kit.BasicServicesKit';

interface Result {
  state?: number;
  realNameLevel?: number;
  verifyResult?: number;
  verifyToken?: string;
}

@Entry
@Component
struct SecondPage {
  obtainFaceVerifyDataInfo(authCode: string, sceneID: number, openID: string, realName: string, idNo: string,
    callback: AsyncCallback<Result>) {
    // 每个httpRequest对应一个HTTP请求任务，且不可重复使用。
    let httpRequest = http.createHttp();
    // 监听HTTP响应头事件，该事件比HTTP请求的响应返回得更早。是否监听HTTP响应头事件由您决定。
    httpRequest.on('headersReceive', (header) => {
      hilog.info(0x0000, 'testTag', 'header: %{public}s', header as string);
    });
    httpRequest.request(
      // 请自行在extraData中自定义EXAMPLE_URL。是否向URL添加参数由您决定。
      'EXAMPLE_URL',
      {
        method: http.RequestMethod.POST,
        // 您可以根据服务需求添加头部字段。
        header: {
          'Content-Type': 'application/json'
        },
        // 使用此字段在POST请求中传递信息。
        extraData: {
          'authCode': authCode,
          'sceneID': sceneID,
          'openID': openID,
          'realname': realName,
          'idNo': idNo
        },
        expectDataType: http.HttpDataType.STRING,
        usingCache: true,
        priority: 1,
        connectTimeout: 60000,
        readTimeout: 60000,
        usingProtocol: http.HttpProtocol.HTTP1_1
      }, (err, data) => {
      if (!err) {
        let res: Result = JSON.parse(data.result as string);
        callback(undefined, res);
      } else {
        let error: BusinessError = { code: err.code, message: err.message, name: '' };
        callback(error, undefined);
        // 取消订阅HTTP响应头事件。
        httpRequest.off('headersReceive');
        // 在httpRequest完成后调用destroy()方法以释放资源。
        httpRequest.destroy();
      }
    });
  }

  build() {
    Row() {
      Column() {
        FunctionalButton({
          params: {
            // OpenType.FACE_AUTHENTICATION表示该按钮用于人脸身份验证。
            openType: functionalButtonComponentManager.OpenType.FACE_AUTHENTICATION,
            label: '人脸核身',
            // 调整按钮样式。
            styleOption: {
              styleConfig: new functionalButtonComponentManager.ButtonConfig()
                .fontSize(20)
            }
          },
          // 当OpenType为FACE_AUTHENTICATION时，回调必须为onFaceAuthentication。
          controller: new functionalButtonComponentManager.FunctionalButtonController()
            .onFaceAuthentication((err, data) => {
              if (err) {
                // 错误日志处理。
                hilog.error(0x0000, 'testTag', 'Failed to authenticate, error: %{public}d %{public}s', err.code, err.message);
                return;
              }
              // 成功日志处理。
              hilog.info(0x0000, 'testTag', 'succeeded in authenticating');
              // 获取授权码。
              let authCode: string = data.authCode as string;
              let openID: string = data.openID as string;
              hilog.info(0x0000, 'testTag', 'succeeded in authCode');
              // sceneid 表示场景ID。选项包括：0（实名验证）、1（人脸验证，验证姓名、证件类型、证件号码和人脸）和2（人脸验证，仅验证人脸）。
              this.obtainFaceVerifyDataInfo(authCode, 2, openID, '', '', (err, data) => {
                if (err) {
                  hilog.error(0x0000, 'testTag', 'error: %{public}d %{public}s', err.code, err.message);
                  return;
                }
                let verifyToken: string = data.verifyToken as string;
                new functionalButtonComponentManager.FunctionalButtonController().onFaceVerification(verifyToken,
                  (error, data) => {
                    if (error) {
                      // 错误日志处理。
                      hilog.error(0x0000, 'testTag', 'Failed to authenticate, error: %{public}d %{public}s', error.code, error.message);
                      return;
                    }
                    let facialRecognitionVerificationToken = data.facialRecognitionVerificationToken;
                    let state = data.state;
                    hilog.info(0x0000, 'testTag', 'auth result success');
                  });
              });
            })
        })
      }
      .width('100%')
    }
    .height('100%')
  }
}

onFaceVerification

onFaceVerification(verifyToken: string, callback: AsyncCallback<FaceVerificationResult>): void

注册FunctionalButton组件为人脸验证的点击事件，使用callback异步回调。

该接口功能依赖Account Kit，参见createAuthorizationWithHuaweiIDRequest，AuthenticationController，executeRequest。

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

元服务API： 从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet中可正常调用，在PC/2in1中返回1001500003错误码，在TV中返回801错误码。

起始版本： 5.0.0(12)

参数：

示例：

import { FunctionalButton, functionalButtonComponentManager } from '@kit.ScenarioFusionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { http } from '@kit.NetworkKit';
import { AsyncCallback, BusinessError } from '@kit.BasicServicesKit';

interface Result {
  state?: number;
  realNameLevel?: number;
  verifyResult?: number;
  verifyToken?: string;
}

@Entry
@Component
struct SecondPage {
  obtainFaceVerifyDataInfo(authCode: string, sceneID: number, openID: string, realName: string, idNo: string,
    callback: AsyncCallback<Result>) {
    // 每个httpRequest对应一个HTTP请求任务，且不可重复使用。
    let httpRequest = http.createHttp();
    // 监听HTTP响应头事件，该事件比HTTP请求的响应返回得更早。是否监听HTTP响应头事件由您决定。
    httpRequest.on('headersReceive', (header) => {
      hilog.info(0x0000, 'testTag', 'header: %{public}s', header as string);
    });
    httpRequest.request(
      // 请自行在extraData中自定义EXAMPLE_URL。是否向URL添加参数由您决定。
      'EXAMPLE_URL',
      {
        method: http.RequestMethod.POST,
        // 您可以根据服务需求添加头部字段。
        header: {
          'Content-Type': 'application/json'
        },
        // 使用此字段在POST请求中传递信息。
        extraData: {
          'authCode': authCode,
          'sceneID': sceneID,
          'openID': openID,
          'realname': realName,
          'idNo': idNo
        },
        expectDataType: http.HttpDataType.STRING,
        usingCache: true,
        priority: 1,
        connectTimeout: 60000,
        readTimeout: 60000,
        usingProtocol: http.HttpProtocol.HTTP1_1
      }, (err, data) => {
      if (!err) {
        let res: Result = JSON.parse(data.result as string);
        callback(undefined, res);
      } else {
        let error: BusinessError = { code: err.code, message: err.message, name: '' };
        callback(error, undefined);
        // 取消订阅HTTP响应头事件。
        httpRequest.off('headersReceive');
        // 在httpRequest完成后调用destroy()方法以释放资源。
        httpRequest.destroy();
      }
    });
  }

  build() {
    Row() {
      Column() {
        FunctionalButton({
          params: {
            // OpenType.FACE_AUTHENTICATION表示该按钮用于人脸身份验证。
            openType: functionalButtonComponentManager.OpenType.FACE_AUTHENTICATION,
            label: '人脸核身',
            // 调整按钮样式。
            styleOption: {
              styleConfig: new functionalButtonComponentManager.ButtonConfig()
                .fontSize(20)
            }
          },
          // 当OpenType为FACE_AUTHENTICATION时，回调必须为onFaceAuthentication。
          controller: new functionalButtonComponentManager.FunctionalButtonController()
            .onFaceAuthentication((err, data) => {
              if (err) {
                // 错误日志处理。
                hilog.error(0x0000, 'testTag', 'Failed to authenticate, error: %{public}d %{public}s', err.code, err.message);
                return;
              }
              // 成功日志处理。
              hilog.info(0x0000, 'testTag', 'succeeded in authenticating');
              // 获取授权码。
              let authCode: string = data.authCode as string;
              let openID: string = data.openID as string;
              hilog.info(0x0000, 'testTag', 'succeeded in authCode');
              // sceneid 表示场景ID。选项包括：0（实名验证）、1（人脸验证，验证姓名、证件类型、证件号码和人脸）和2（人脸验证，仅验证人脸）。
              this.obtainFaceVerifyDataInfo(authCode, 2, openID, '', '', (err, data) => {
                if (err) {
                  hilog.error(0x0000, 'testTag', 'error: %{public}d %{public}s', err.code, err.message);
                  return;
                }
                let verifyToken: string = data.verifyToken as string;
                new functionalButtonComponentManager.FunctionalButtonController().onFaceVerification(verifyToken,
                  (error, data) => {
                    if (error) {
                      // 错误日志处理。
                      hilog.error(0x0000, 'testTag', 'Failed to authenticate, error: %{public}d %{public}s', error.code, error.message);
                      return;
                    }
                    let facialRecognitionVerificationToken = data.facialRecognitionVerificationToken;
                    let state = data.state;
                    hilog.info(0x0000, 'testTag', 'auth result success');
                  });
              });
            })
        })
      }
      .width('100%')
    }
    .height('100%')
  }
}

onChooseLocation

onChooseLocation(callback: AsyncCallback<ChooseLocationResult>): FunctionalButtonController

注册FunctionalButton组件为打开地图选点的点击事件，使用callback异步回调。

该接口功能依赖Map Kit，参见chooseLocation。

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

元服务API： 从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1中可正常调用，在其他设备类型中返回801错误码。

起始版本： 5.0.0(12)

参数：

返回值：

示例：

import { FunctionalButton, functionalButtonComponentManager } from '@kit.ScenarioFusionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

@Entry
@Component
struct Index {
  build() {
    Row() {
      Column() {
        // 构建FunctionalButton组件实例。
        FunctionalButton({
          params: {
            // OpenType.CHOOSE_LOCATION表示该按钮用于在地图上选择位置。
            openType: functionalButtonComponentManager.OpenType.CHOOSE_LOCATION,
            label: '地图选点',
            // 调整按钮样式。
            styleOption: {
              bgColor:functionalButtonComponentManager.ColorType.DEFAULT,
              size: functionalButtonComponentManager.SizeType.DEFAULT,
              plain: false,
              disabled:false,
              loading: false,
              hoverClass: functionalButtonComponentManager.HoverClassType.HOVER_CLASS,
              hoverStartTime: 0,
              hoverStayTime: 0,
              styleConfig: new functionalButtonComponentManager.ButtonConfig()
                .fontSize(20)
            }
          },
          // 当OpenType设置为CHOOSE_LOCATION时，回调必须为onChooseLocation。
          controller: new functionalButtonComponentManager.FunctionalButtonController()
            .onChooseLocation((err, data) => {
              if (err) {
                // 错误日志处理。
                hilog.error(0x0000, 'testTag', 'Failed to choose location, error: %{public}d %{public}s', err.code, err.message);
                return;
              }
              // 成功日志处理。
              hilog.info(0x0000, 'testTag', 'succeeded in choosing location');
              let name: string = data.name;
              let address: string = data.address;
              let longitude: number = data.longitude;
              let latitude: number = data.latitude;
            })
        })
      }.width('100%')
    }.height('100%')
  }
}

onSubscribeLiveView

onSubscribeLiveView(callback: AsyncCallback<SubscribeLiveViewResult>): FunctionalButtonController

注册FunctionalButton组件为实况窗订阅的点击事件，使用callback异步回调。

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

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet中可正常调用，在其他设备类型中返回801错误码。

起始版本： 5.0.0(12)

参数：

返回值：

错误码：

以下错误码的详细介绍请参见ArkTS组件错误码。

示例：

import { hilog } from '@kit.PerformanceAnalysisKit';
import { FunctionalButton, functionalButtonComponentManager } from '@kit.ScenarioFusionKit';

@Entry
@Component
struct Index {
  build() {
    Row() {
      Column() {
        // 构建FunctionalButton组件实例。
        FunctionalButton({
          params: {
            // OpenType.SUBSCRIBE_LIVE_VIEW表示该按钮用于实时视图订阅。
            openType: functionalButtonComponentManager.OpenType.SUBSCRIBE_LIVE_VIEW,
            label: '预约抢购',
            // 调整按钮样式。
            styleOption: {
              styleConfig: new functionalButtonComponentManager.ButtonConfig()
                .fontSize(20)
            },
            subscribeLiveViewParam: {
              event: 'SUBSCRIBE_TIMER',
              alertTime: 172178838111,
              startTime: 172170198111
            }
          },
          // 当OpenType为SUBSCRIBE_LIVE_VIEW时，回调必须为onSubscribeLiveView。
          controller: new functionalButtonComponentManager.FunctionalButtonController().onSubscribeLiveView((err,
            data) => {
            if (err) {
              // 错误日志处理。
              hilog.error(0x0000, 'testTag', `Failed to subscribe LiveView, error code is: ${err?.code} message is ${err?.message}`);
              return;
            }
            let subscribeId = data.subscribeId;
            // 成功日志处理。
            hilog.info(0x0000, 'testTag', 'succeeded in subscribing LiveView');
          })
        })
      }
      .width('100%')
    }
    .height('100%')
  }
}

onPermissionSetting

onPermissionSetting(callback: AsyncCallback<PermissionSettingResult>): FunctionalButtonController

注册FunctionalButton组件为权限设置的点击事件，使用callback异步回调。

该接口功能依赖Ability Kit，参见requestPermissionOnSetting。

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

元服务API： 从版本5.0.2(14)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1、TV中可正常调用，在其他设备类型中返回801错误码。

起始版本： 5.0.2(14)

参数：

返回值：

示例：

import { FunctionalButton, functionalButtonComponentManager } from '@kit.ScenarioFusionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { abilityAccessCtrl, common, PermissionRequestResult } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Index {
  build() {
    Row() {
      Column({ space: 3 }) {
        // 调用requestPermissionsFromUser接口Button。
        Button('请求用户授权')
          .fontSize(20)
          .onClick(() => {
            let atManager: abilityAccessCtrl.AtManager = abilityAccessCtrl.createAtManager();
            let context: Context = this.getUIContext().getHostContext() as common.UIAbilityContext;
            try {
              // 在module.json5文件中添加ohos.permission.READ_CALENDAR、ohos.permission.WRITE_CALENDAR权限。
              atManager.requestPermissionsFromUser(context,
                ['ohos.permission.READ_CALENDAR', 'ohos.permission.WRITE_CALENDAR'],
                (err: BusinessError, data: PermissionRequestResult) => {
                  if (err) {
                    hilog.error(0x0000, 'testTag', 'failed in requesting Permissions from user : %{public}d %{public}s',
                      err.code, err.message);
                  } else {
                   hilog.info(0x0000, 'testTag', 'data permissions: %{public}s', data.permissions?.join(','));
                   hilog.info(0x0000, 'testTag', 'data authResults: %{public}s', data.authResults?.join(','));
                   hilog.info(0x0000, 'testTag', 'data dialogShownResults: %{public}s', data.dialogShownResults?.join(','));
                  }
                });
            } catch (err) {
              hilog.error(0x0000, 'testTag', 'error: %{public}d %{public}s', err.code, err.message);
            }
          })

        // 构建FunctionalButton组件实例。
        FunctionalButton({
          params: {
            // OpenType.PERMISSION_SETTING表示该按钮用于设置权限。
            openType: functionalButtonComponentManager.OpenType.PERMISSION_SETTING,
            label: '权限设置',
            permissionListParam: ['ohos.permission.READ_CALENDAR', 'ohos.permission.WRITE_CALENDAR'],
            // 调整按钮样式。
            styleOption: {
              styleConfig: new functionalButtonComponentManager.ButtonConfig()
                .fontSize(20)
            }
          },
          // 当OpenType设置为PERMISSION_SETTING时，回调必须为onPermissionSetting。
          controller: new functionalButtonComponentManager.FunctionalButtonController().onPermissionSetting((err,
            data) => {
            if (err) {
              // 错误日志处理。
              hilog.error(0x0000, 'testTag', 'Failed to set permission, error: %{public}d %{public}s', err.code, err.message);
              return;
            }
            // 成功日志处理。
            hilog.info(0x0000, 'testTag', 'succeeded in setting permission ');
            let result = data.permissionResult;
            result.forEach(res => {
              hilog.info(0x0000, 'testTag', 'data: %{public}s', String(res));
            });
          })
        })
      }
      .width('100%')
    }
    .height('100%')
  }
}

onRequestSubscribeMessage

onRequestSubscribeMessage(callback: AsyncCallback<RequestSubscribeMessageResult>): FunctionalButtonController

注册FunctionalButton组件为服务动态授权码按钮的点击事件，使用callback异步回调。

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

元服务API： 从版本6.0.0(20)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1中可正常调用，在其他设备类型中返回801错误码。

起始版本： 6.0.0(20)

参数：

返回值：

错误码：

以下错误码的详细介绍请参见ArkTS组件错误码。

示例：

import { FunctionalButton, functionalButtonComponentManager } from '@kit.ScenarioFusionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
@Entry
@Component
struct Index {
  build() {
    Row() {
      Column() {
        // 构建FunctionalButton组件实例。
        FunctionalButton({
          params: {
            // OpenType.REQUEST_SUBSCRIBE_MESSAGE表示该按钮用于获取服务动态授权码。
            openType: functionalButtonComponentManager.OpenType.REQUEST_SUBSCRIBE_MESSAGE,
            label: '服务动态授权码',
            // 在获取服务动态授权码时，名为subSceneId的参数是必填项。
            subSceneId: '',
            // 调整按钮样式。
            styleOption: {
              styleConfig: new functionalButtonComponentManager.ButtonConfig()
                .fontSize(20)
            }
          },
          // 当OpenType为REQUEST_SUBSCRIBE_MESSAGE时，回调必须为onRequestSubscribeMessage。
          controller: new functionalButtonComponentManager.FunctionalButtonController()
            .onRequestSubscribeMessage((err, data) => {
              if (err) {
                // 错误日志处理。
                hilog.error(0x0000, 'testTag', 'Failed to request subscribe message, error: %{public}d %{public}s', err.code, err.message);
                return;
              }
              // 成功日志处理。
              hilog.info(0x0000, 'testTag', 'succeeded in requesting subscribe message');
              // 处理服务代码。
              let code = data.code;
            })
        })
      }.width('100%')
    }.height('100%')
  }
}

onShare

onShare(callback: AsyncCallback<void>): FunctionalButtonController

注册FunctionalButton组件为分享按钮的点击事件，使用callback异步回调。

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

元服务API： 从版本6.0.0(20)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1中可正常调用，在其他设备类型中返回801错误码。

起始版本： 6.0.0(20)

参数：

返回值：

错误码：

以下错误码的详细介绍请参见ArkTS组件错误码。

示例：

import { FunctionalButton, functionalButtonComponentManager } from '@kit.ScenarioFusionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

@Entry
@Component
struct Index {
  build() {
    Row() {
      Column() {
        // 构建FunctionalButton组件实例。
        FunctionalButton({
          params: {
            // OpenType.SHARE 表示该按钮用于调出分享页面。
            openType: functionalButtonComponentManager.OpenType.SHARE,
            label: '元服务分享',
            shareParam: {
              previewUri: '',
              description: ''
            },
            // 调整按钮样式。
            styleOption: {
              styleConfig: new functionalButtonComponentManager.ButtonConfig()
                .fontSize(20)
            }
          },
          // 当OpenType设置为SHARE时，回调函数必须是onShare。
          controller: new functionalButtonComponentManager.FunctionalButtonController()
            .onShare((err) => {
              if (err) {
                // 错误日志处理。
                hilog.error(0x0000, 'testTag', 'Failed to pull up the sharing page, error: %{public}d %{public}s', err.code, err.message);
                return;
              }
              // 成功日志处理。
              hilog.info(0x0000, 'testTag', 'succeeded in pulling up the sharing page');
            })
        })
      }.width('100%')
    }.height('100%')
  }
}

onFeedback

onFeedback(callback: AsyncCallback<void>): FunctionalButtonController

注册FunctionalButton组件为反馈按钮的点击事件，使用callback异步回调。

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

元服务API： 从版本6.0.0(20)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

设备行为差异： 该接口在Phone、Tablet、PC/2in1中可正常调用，在其他设备类型中返回801错误码。

起始版本： 6.0.0(20)

参数：

返回值：

错误码：

以下错误码的详细介绍请参见ArkTS组件错误码。

示例：

import { FunctionalButton, functionalButtonComponentManager } from '@kit.ScenarioFusionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

@Entry
@Component
struct Index {
  build() {
    Row() {
      Column() {
        // 构建FunctionalButton组件实例。
        FunctionalButton({
          params: {
            // OpenType.FEEDBACK表示该按钮用于拉起反馈页面。
            openType: functionalButtonComponentManager.OpenType.FEEDBACK,
            label: '反馈与投诉',
            // 调整按钮样式。
            styleOption: {
              styleConfig: new functionalButtonComponentManager.ButtonConfig()
                .fontSize(20)
            }
          },
          // 当OpenType设置为FEEDBACK时，回调函数必须是onFeedback。
          controller: new functionalButtonComponentManager.FunctionalButtonController()
            .onFeedback((err) => {
              if (err) {
                // 错误日志处理。
                hilog.error(0x0000, 'testTag', 'Failed to pull up the feedback page, error: %{public}d %{public}s', err.code, err.message);
                return;
              }
              // 成功日志处理。
              hilog.info(0x0000, 'testTag', 'succeeded in pulling up the feedback page');
            })
        })
      }.width('100%')
    }.height('100%')
  }
}

onGetPhoneNumberAndRiskLevel

onGetPhoneNumberAndRiskLevel(callback: Callback<GetPhoneNumberAndRiskLevelResult>): FunctionalButtonController

注册FunctionalButton组件为获取手机号和风险等级的点击事件，使用callback同步回调。

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

元服务API： 从版本6.0.2(22)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 6.0.2(22)

参数：

返回值：

示例：

import { FunctionalButton, functionalButtonComponentManager } from '@kit.ScenarioFusionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

@Entry
@Component
struct Index {
  build() {
    Row() {
      Column() {
        // 构建FunctionalButton组件实例。
        FunctionalButton({
          params: {
            // OpenType.GET_PHONE_NUMBER_AND_RISK_LEVEL表示该按钮用于获取手机号和风险等级。
            openType: functionalButtonComponentManager.OpenType.GET_PHONE_NUMBER_AND_RISK_LEVEL,
            label: '获取手机号和风险等级',
            // 调整按钮样式。
            styleOption: {
              styleConfig: new functionalButtonComponentManager.ButtonConfig()
                .fontSize(20)
            }
          },
          // 当OpenType为GET_PHONE_NUMBER_AND_RISK_LEVEL时，回调必须为onGetPhoneNumberAndRiskLevel。
          controller: new functionalButtonComponentManager.FunctionalButtonController()
            .onGetPhoneNumberAndRiskLevel((data) => {
              if (data?.errCode) {
                // 错误日志处理。
                hilog.error(0x0000, 'testTag', 'Failed to authenticate, error: %{public}d %{public}s', data?.errCode, data?.errMsg);
                return;
              }
              // 成功日志处理。
              hilog.info(0x0000, 'testTag', 'succeeded in authentication');
              // 授权码处理。
              let authorizationCode = data?.code;
            })
        })
      }
      .width('100%')
    }
    .height('100%')
  }
}

ButtonConfig

该类提供了实现FunctionalButton自定义属性的方法。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

type

type(value: ButtonType): ButtonConfig

设置FunctionalButton的显示样式属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

stateEffect

stateEffect(value: boolean): ButtonConfig

设置FunctionalButton是否开启按压态显示效果属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

fontColor

fontColor(value: ResourceColor): ButtonConfig

设置FunctionalButton的字体颜色属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

fontSize

fontSize(value: Length): ButtonConfig

设置FunctionalButton的字体大小属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

fontWeight

fontWeight(value: string | number | FontWeight): ButtonConfig

设置FunctionalButton的字体粗细属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

fontStyle

fontStyle(value: FontStyle): ButtonConfig

设置FunctionalButton的字体样式属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

fontFamily

fontFamily(value: string | Resource): ButtonConfig

设置FunctionalButton的字体属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

width

width(value: Length): ButtonConfig

设置FunctionalButton的宽度属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

height

height(value: Length): ButtonConfig

设置FunctionalButton的高度属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

size

size(value: SizeOptions): ButtonConfig

设置FunctionalButton的高宽尺寸属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

constraintSize

constraintSize(value: ConstraintSizeOptions): ButtonConfig

设置FunctionalButton的约束尺寸属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

padding

padding(value: Length | Padding): ButtonConfig

设置FunctionalButton的内边距属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

margin

margin(value: Length | Padding): ButtonConfig

设置FunctionalButton的外边距属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

backgroundColor

backgroundColor(value: ResourceColor): ButtonConfig

设置FunctionalButton的背景色属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

backgroundImage

backgroundImage(src: ResourceStr, repeat?: ImageRepeat): ButtonConfig

设置FunctionalButton的背景图像属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

backgroundImageSize

backgroundImageSize(value: SizeOptions | ImageSize): ButtonConfig

设置FunctionalButton的背景图像的高度和宽度属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

backgroundImagePosition

backgroundImagePosition(value: Position | Alignment): ButtonConfig

设置FunctionalButton的背景图像的显示位置属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

opacity

opacity(value: number | Resource): ButtonConfig

设置FunctionalButton的透明度属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

border

border(value: BorderOptions): ButtonConfig

统一设置FunctionalButton的边框宽度、边框颜色、边框圆角半径、边框样式属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

borderStyle

borderStyle(value: BorderStyle | EdgeStyles): ButtonConfig

设置FunctionalButton的边框样式属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

borderWidth

borderWidth(value: Length | EdgeWidths): ButtonConfig

设置FunctionalButton的边框宽度属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

borderColor

borderColor(value: ResourceColor | EdgeColors): ButtonConfig

设置FunctionalButton的边框颜色属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

borderRadius

borderRadius(value: Length | BorderRadiuses): ButtonConfig

设置FunctionalButton的边框圆角半径属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

borderImage

borderImage(value: BorderImageOption): ButtonConfig

设置FunctionalButton的图片边框属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

scale

scale(value: ScaleOptions): ButtonConfig

设置FunctionalButton的缩放属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

align

align(value: Alignment): ButtonConfig

设置FunctionalButton的对齐方式属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

markAnchor

markAnchor(value: Position): ButtonConfig

设置FunctionalButton在位置定位时的锚点。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

offset

offset(value: Position): ButtonConfig

设置FunctionalButton在位置坐标偏移量。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

enabled

enabled(value: boolean): ButtonConfig

设置FunctionalButton的是否禁用属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

loadingColor

loadingColor(value: ResourceColor): ButtonConfig

设置FunctionalButton中的LoadingProgress图标的颜色属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

loadingWidth

loadingWidth(value: Length): ButtonConfig

设置FunctionalButton中的LoadingProgress图标的宽度属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

loadingHeight

loadingHeight(value: Length): ButtonConfig

设置FunctionalButton中的LoadingProgress图标的高度属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

loadingPadding

loadingPadding(value: Length | Padding): ButtonConfig

设置FunctionalButton中的LoadingProgress图标的内边距属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

loadingMargin

loadingMargin(value: Length | Padding): ButtonConfig

设置FunctionalButton中的LoadingProgress图标的外边距属性。

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

元服务API： 从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.AtomicserviceComponent.UIComponent

起始版本： 4.1.0(11)

参数：

返回值：

示例

示例一（场景化Button使用自定义Modifier设置按钮样式）

import { FunctionalButton, functionalButtonComponentManager } from '@kit.ScenarioFusionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { ButtonModifier, LoadingProgressModifier, TextModifier } from '@kit.ArkUI';

@Entry
@Component
struct Index {
  build() {
    Row() {
      Column() {
        // 构建FunctionalButton组件实例。
        FunctionalButton({
          params: {
            // OpenType.GET_PHONE_NUMBER表示该按钮用于快速验证手机号码。
            openType: functionalButtonComponentManager.OpenType.GET_PHONE_NUMBER,
            label: '快速验证手机号',
            // 调整按钮样式。
            styleOption: {
              loading: true
            },
            textModifier: new TextModifier().fontColor(Color.Pink),
            buttonModifier: new ButtonModifier().backgroundColor(Color.Green),
            loadingProgressModifier: new LoadingProgressModifier().width(20).height(20)
          },
          // 当OpenType为GET_PHONE_NUMBER时，回调必须为onGetPhoneNumber。
          controller: new functionalButtonComponentManager.FunctionalButtonController()
            .onGetPhoneNumber((err, data) => {
              if (err) {
                // 错误日志处理。
                hilog.error(0x0000, 'testTag', 'Failed to authenticate, error: %{public}d %{public}s', err.code, err.message);
                return;
              }
              // 成功日志处理。
              hilog.info(0x0000, 'testTag', 'succeeded in authenticating');
              // 处理授权码。
              let authorizationCode = data.code;
            })
        })
      }
      .width('100%')
    }
    .height('100%')
  }
}