對(duì)卡片的相關(guān)卡片信息和狀態(tài)進(jìn)行設(shè)置和查詢的能力

2024-01-23 12:52 更新

FormInfo模塊提供對(duì)卡片的相關(guān)卡片信息和狀態(tài)進(jìn)行設(shè)置和查詢的能力。

說明

本模塊首批接口從API version 9開始支持。后續(xù)版本的新增接口,采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。

導(dǎo)入模塊

  1. import formInfo from '@ohos.app.form.formInfo';

FormInfo

卡片信息

系統(tǒng)能力:SystemCapability.Ability.Form

名稱

類型

可讀

可寫

說明

bundleName

string

卡片所屬包的包名。

moduleName

string

卡片所屬模塊的模塊名。

abilityName

string

卡片所屬的Ability名稱。

name

string

卡片名稱。

description

string

卡片描述。

type

FormType

卡片類型。當(dāng)前支持JS卡片。

jsComponentName

string

js卡片的組件名。

colorMode

ColorMode

卡片顏色模式。

isDefault

boolean

卡片是否是默認(rèn)卡片。

updateEnabled

boolean

卡片是否使能更新。

formVisibleNotify

string

卡片是否使能可見通知。

scheduledUpdateTime

string

卡片更新時(shí)間。

formConfigAbility

string

卡片配置ability。指定長(zhǎng)按卡片彈出的選擇框內(nèi),編輯選項(xiàng)所對(duì)應(yīng)的ability。

updateDuration

string

卡片更新周期。

defaultDimension

number

表示卡片規(guī)格

supportDimensions

Array<number>

卡片支持的規(guī)格。具體可選規(guī)格參考FormDimension

customizeData

{[key: string]: [value: string]}

卡片用戶數(shù)據(jù)。

FormType

支持的卡片類型枚舉。

系統(tǒng)能力:SystemCapability.Ability.Form

名稱

說明

JS

1

卡片類型為JS。

eTS

2

卡片類型為eTS。

ColorMode

卡片支持的顏色模式枚舉。

系統(tǒng)能力:SystemCapability.Ability.Form

名稱

說明

MODE_AUTO

-1

表示自動(dòng)模式。

MODE_DARK

0

表示暗色。

MODE_LIGHT

1

表示亮色。

FormStateInfo

卡片狀態(tài)信息。

系統(tǒng)能力:SystemCapability.Ability.Form

名稱

類型

可讀

可寫

說明

formState

FormState

卡片狀態(tài)。

want

Want

Want文本內(nèi)容。

FormState

卡片狀態(tài)枚舉。

系統(tǒng)能力:SystemCapability.Ability.Form

名稱

說明

UNKNOWN

-1

表示未知狀態(tài)。

DEFAULT

0

表示默認(rèn)狀態(tài)。

READY

1

表示就緒狀態(tài)。

FormParam

卡片參數(shù)枚舉。

系統(tǒng)能力:SystemCapability.Ability.Form

名稱

說明

IDENTITY_KEY

"ohos.extra.param.key.form_identity"

卡片標(biāo)識(shí)。

DIMENSION_KEY

"ohos.extra.param.key.form_dimension"

卡片規(guī)格樣式。

NAME_KEY

"ohos.extra.param.key.form_name"

卡片名稱。

MODULE_NAME_KEY

"ohos.extra.param.key.module_name"

卡片所屬模塊名稱。

WIDTH_KEY

"ohos.extra.param.key.form_width"

卡片寬度。

HEIGHT_KEY

"ohos.extra.param.key.form_height"

卡片高度。

TEMPORARY_KEY

"ohos.extra.param.key.form_temporary"

臨時(shí)卡片。

ABILITY_NAME_KEY

"ohos.extra.param.key.ability_name"

ability名稱

BUNDLE_NAME_KEY

"ohos.extra.param.key.bundle_name"

指示指定要獲取的捆綁包名稱的鍵。

FormDimension

定義卡片尺寸枚舉。

系統(tǒng)能力:SystemCapability.Ability.Form

名稱

說明

Dimension_1_2

1

1 x 2 form。

Dimension_2_2

2

2 x 2 form。

Dimension_2_4

3

2 x 4 form。

Dimension_4_4

4

4 x 4 form。

Dimension_2_1

5

2 x 1 form。

FormInfoFilter

卡片信息過濾器,僅將符合過濾器內(nèi)要求的卡片信息返回。

系統(tǒng)能力:SystemCapability.Ability.Form

名稱

說明

moduleName

僅保留moduleName與提供值相符的卡片信息。

VisibilityType

卡片當(dāng)前可見類型枚舉。

系統(tǒng)能力:SystemCapability.Ability.Form

名稱

說明

FORM_VISIBLE

1

表示卡片為可見。

FORM_INVISIBLE

2

表示卡片為不可見。

以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)