程序包 ohos.data.search.schema

类 ActionItem

java.lang.Object

ohos.data.search.model.IndexData

ohos.data.search.schema.Schema<ActionItem>

ohos.data.search.schema.ActionItem

public final class ActionItem
extends Schema<ActionItem>

Represents the index schema for actions that can be performed within an application.

This schema is used to create indexes for in-app actions. For example, after an index is added for the action of creating a note in a notepad application, the application user can search for this action in a global search. This allows for immediate access to action items within this application.

The schema supports index field actionName and all the fields in CommonItem. Among these fields, identifier is mandatory and can be set via the CommonItem#setIdentifier(String) method.

从以下版本开始:

5

SystemCapability

SystemCapability.Data#DATA_SEARCH

字段概要

字段

限定符和类型	字段	说明
static String	ACTION_NAME	Indicates the index field name of actionName.

构造器概要

构造器

构造器	说明
ActionItem()	A constructor used to create an ActionItem instance.

方法概要

限定符和类型	方法	说明
String	getActionName()	Obtains the value of the actionName index field.
static List<IndexForm>	getActionSchema()	Obtains the attributes of index fields in this index schema.
ActionItem	setActionName(String actionName)	Sets the actionName index field.

从类继承的方法 ohos.data.search.model.IndexData

clear, get, getAsDouble, getAsFloat, getAsInteger, getAsLong, getAsString, getValues, isEmpty, put, put, put, put, put, remove, setValues, size

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从类继承的方法 ohos.data.search.schema.Schema

getAlternateName, getCategory, getDateCreate, getDescription, getIdentifier, getKeywords, getName, getPotentialAction, getReserved1, getReserved2, getSubtitle, getThumbnailUrl, getTitle, getUrl, setAlternateName, setCategory, setDateCreate, setDescription, setIdentifier, setKeywords, setName, setPotentialAction, setReserved1, setReserved2, setSubtitle, setThumbnailUrl, setTitle, setUrl

字段详细资料

ACTION_NAME

public static final String ACTION_NAME

Indicates the index field name of actionName.

从以下版本开始:

5

另请参阅:

常量字段值

构造器详细资料

ActionItem

public ActionItem()

A constructor used to create an ActionItem instance.

从以下版本开始:

5

方法详细资料

getActionSchema

public static List<IndexForm> getActionSchema()

Obtains the attributes of index fields in this index schema.

返回:

Returns the list of index field attributes.

从以下版本开始:

5

setActionName

public ActionItem setActionName(String actionName)

Sets the actionName index field.

Attributes of this index field: IndexForm.indexFieldName = "actionName"; IndexForm.indexType = IndexType.ANALYZED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;

参数:

actionName - Indicates the action name to set.

返回:

Returns this ActionItem object.

从以下版本开始:

5

getActionName

public String getActionName()

Obtains the value of the actionName index field.

返回:

Returns the value of the actionName index field.

从以下版本开始:

5