HarmonyOS API:通用能力的接口

joytrian
发布于 2023-3-31 18:04
浏览
0收藏

版本:v3.1 Beta

@ohos.application.formProvider (FormProvider)

更新时间: 2023-02-17 09:19


FormProvider模块提供了卡片提供方相关接口的能力,开发者在开发卡片时,可通过该模块提供接口实现更新卡片,设置卡片更新时间,获取卡片信息,请求发布卡片等。


说明

本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。


从API version 9 开始不再维护,建议使用​​FormProvider​​替代。

导入模块

import formProvider from '@ohos.application.formProvider';

setFormNextRefreshTime

setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback<void>): void

设置指定卡片的下一次更新时间,使用callback异步回调。

系统能力: SystemCapability.Ability.Form

参数:

参数名

类型

必填

说明

formId

string

卡片标识。

minute

number

指定多久之后更新,单位分钟,大于等于5。

callback

AsyncCallback<void>

回调函数。

示例:

var formId = "12400633174999288";
formProvider.setFormNextRefreshTime(formId, 5, (error, data) => {
    if (error.code) {
        console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error));
    }
});

setFormNextRefreshTime

setFormNextRefreshTime(formId: string, minute: number): Promise<void>

设置指定卡片的下一次更新时间,使用Promise异步回调。

系统能力: SystemCapability.Ability.Form

参数:

参数名

类型

必填

说明

formId

string

卡片标识。

minute

number

指定多久之后更新,单位分钟,大于等于5。

返回值:

类型

说明

Promise<void>

无返回结果的Promise对象。

示例:

var formId = "12400633174999288";
formProvider.setFormNextRefreshTime(formId, 5).then(() => {
    console.log('formProvider setFormNextRefreshTime success');
}).catch((error) => {
    console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error));
});

updateForm

updateForm(formId: string, formBindingData: formBindingData.FormBindingData,callback: AsyncCallback<void>): void

更新指定的卡片,使用callback异步回调。

系统能力: SystemCapability.Ability.Form

参数:

参数名

类型

必填

说明

formId

string

请求更新的卡片标识。

formBindingData.FormBindingData

​FormBindingData​

用于更新的数据。

callback

AsyncCallback<void>

回调函数。

示例:

import formBindingData from '@ohos.application.formBindingData';
var formId = "12400633174999288";
let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
formProvider.updateForm(formId, obj, (error, data) => {
    if (error.code) {
        console.log('formProvider updateForm, error:' + JSON.stringify(error));
    }
});

updateForm

updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Promise<void>

更新指定的卡片,使用Promise异步回调。

系统能力: SystemCapability.Ability.Form

参数:

参数名

类型

必填

说明

formId

string

请求更新的卡片标识。

formBindingData.FormBindingData

​FormBindingData​

用于更新的数据。

返回值:

类型

说明

Promise<void>

无返回结果的Promise对象。

示例:

import formBindingData from '@ohos.application.formBindingData';
var formId = "12400633174999288";
let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
formProvider.updateForm(formId, obj).then(() => {
    console.log('formProvider updateForm success');
}).catch((error) => {
    console.log('formProvider updateForm, error:' + JSON.stringify(error));
});

@ohos.application.Want (Want)

更新时间: 2023-02-17 09:19


Want是对象间信息传递的载体, 可以用于应用组件间的信息传递。 Want的使用场景之一是作为startAbility的参数, 其包含了指定的启动目标, 以及启动时需携带的相关数据, 如bundleName和abilityName字段分别指明目标Ability所在应用的包名以及对应包内的Ability名称。当Ability A需要启动Ability B并传入一些数据时, 可使用Want作为载体将这些数据传递给Ability B。


说明

本模块首批接口从API version 8 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import Want from '@ohos.application.Want';

属性

系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase

名称

类型

必填

说明

deviceId

string

表示运行指定Ability的设备ID。

bundleName

string

表示包描述。如果在Want中同时指定了BundleName和AbilityName,则Want可以直接匹配到指定的Ability。

abilityName

string

表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName,则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。

uri

string

表示Uri描述。如果在Want中指定了Uri,则Want将匹配指定的Uri信息,包括scheme, schemeSpecificPart, authority和path信息。

type

string

表示MIME type类型描述,打开文件的类型,主要用于文管打开文件。比如:"text/xml" 、 "image/*"等,MIME定义参考:https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。

flags

number

表示处理Want的方式。默认传数字,具体参考:​​flags说明​​。

action

string

表示要执行的通用操作(如:查看、分享、应用详情)。在隐式Want中,您可以定义该字段,配合uri或parameters来表示对数据要执行的操作。

parameters

{[key: string]: any}

表示WantParams描述,由开发者自行决定传入的键值对。默认会携带以下key值:

ohos.aafwk.callerPid 表示拉起方的pid。

ohos.aafwk.param.callerToken 表示拉起方的token。

ohos.aafwk.param.callerUid 表示​​bundleInfo​​中的uid,应用包里应用程序的uid。

entities

Array<string>

表示目标Ability额外的类别信息(如:浏览器、视频播放器),在隐式Want中是对action字段的补充。在隐式Want中,您可以定义该字段,来过滤匹配Ability类型。

moduleName9+

string

表示待启动的Ability所属的模块(module)。

示例:

  • 基础用法

  var want = {
      "deviceId": "", // deviceId为空表示本设备
      "bundleName": "com.extreme.test",
      "abilityName": "MainAbility",
      "moduleName": "entry" // moduleName非必选
  };
  this.context.startAbility(want, (error) => {
      // 显式拉起Ability,通过bundleName、abilityName和moduleName可以唯一确定一个Ability
      console.log("error.code = " + error.code)
  })
  • 通过自定字段传递数据, 以下为当前支持类型。
  • 字符串(String)

let want = {
    bundleName: "com.example.demo",
    abilityName: "com.example.demo.MainAbility",
    parameters: {
        keyForString: "str",
    },
}
  • 数字(Number)

let want = {
    bundleName: "com.example.demo",
    abilityName: "com.example.demo.MainAbility",
    parameters: {
        keyForInt: 100,
        keyForDouble: 99.99,
    },
}
  • 布尔(Boolean)

let want = {
    bundleName: "com.example.demo",
    abilityName: "com.example.demo.MainAbility",
    parameters: {
        keyForBool: true,
    },
}
  • 对象(Object)

let want = {
    bundleName: "com.example.demo",
    abilityName: "com.example.demo.MainAbility",
    parameters: {
        keyForObject: {
            keyForObjectString: "str",
            keyForObjectInt: -200,
            keyForObjectDouble: 35.5,
            keyForObjectBool: false,
        },
    },
}
  • 数组(Array)

let want = {
    bundleName: "com.example.demo",
    abilityName: "com.example.demo.MainAbility",
    parameters: {
        keyForArrayString: ["str1", "str2", "str3"],
        keyForArrayInt: [100, 200, 300, 400],
        keyForArrayDouble: [0.1, 0.2],
        keyForArrayObject: [{obj1: "aaa"}, {obj2: 100}],
    },
}
  • 文件描述符(FD)

    import fileio from '@ohos.fileio';
    var fd;
    try {
        fd = fileio.openSync("/data/storage/el2/base/haps/pic.png");
    } catch(e) {
        console.log("openSync fail:" + JSON.stringify(e));
    }
    var want = {
        "deviceId": "", // deviceId为空表示本设备
        "bundleName": "com.extreme.test",
        "abilityName": "MainAbility",
        "moduleName": "entry", // moduleName非必选
        "parameters": {
            "keyFd":{"type":"FD", "value":fd}
        }
    };
    this.context.startAbility(want, (error) => {
        // 显式拉起Ability,通过bundleName、abilityName和moduleName可以唯一确定一个Ability
        console.log("error.code = " + error.code)
    })


文章转载自:​​https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-application-want-0000001477981345-V3?catalogVersion=V3​

已于2023-3-31 18:04:58修改
收藏
回复
举报
回复