程序包 ohos.aafwk.content

类 IntentParams

java.lang.Object

ohos.aafwk.content.IntentParams

所有已实现的接口:

Sequenceable

public class IntentParams
extends Object
implements Sequenceable

Stores extra parameter information passed to an Ability.

Parameter information in IntentParams is saved in the form of key-value pairs. The keys are of the String type, and the values are saved as objects of the Object type. You can use the setParam(java.lang.String,java.lang.Object) method to set parameters.

从以下版本开始:

1

SystemCapability

SystemCapability.Aafwk#INTENT

嵌套类概要

从接口继承的嵌套类/接口 ohos.utils.Sequenceable

Sequenceable.Producer<T>

字段概要

字段

限定符和类型	字段	说明
static Sequenceable.Producer<IntentParams>	PRODUCER	Creates a IntentParams instance from a Parcel.

构造器概要

构造器

构造器	说明
IntentParams()	A constructor used to create an empty IntentParams instance.
IntentParams(IntentParams intentParams)	A constructor used to create an IntentParams instance by using the parameters of an existing IntentParams object.

方法概要

限定符和类型	方法	说明
ClassLoader	getClassLoader()	Obtains the ClassLoader used for the custom parameters of the Sequenceable type.
Object	getParam(String key)	Obtains the parameter value based on a given key.
boolean	hasParam(String key)	Checks whether the Intent contains the given key.
boolean	isEmpty()	Checks whether this IntentParams object contains no parameters.
Set<String>	keySet()	Obtains a set of the keys of all parameters.
boolean	marshalling(Parcel out)	Marshals an IntentParams object into a Parcel.
void	remove(String key)	Removes the parameter matching the given key.
void	setClassLoader(ClassLoader classLoader)	Sets the ClassLoader used for the custom parameters of the Sequenceable type.
<T> void	setParam(String key, T value)	Sets a parameter in key-value pair format.
int	size()	Obtains the number of parameters contained in this IntentParams object.
boolean	unmarshalling(Parcel in)	Unmarshals an IntentParams object from a Parcel.

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

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

从接口继承的方法 ohos.utils.Sequenceable

hasFileDescriptor

字段详细资料

PRODUCER

public static final Sequenceable.Producer<IntentParams> PRODUCER

Creates a IntentParams instance from a Parcel.

从以下版本开始:

4

构造器详细资料

IntentParams

public IntentParams()

A constructor used to create an empty IntentParams instance.

从以下版本开始:

1

IntentParams

public IntentParams(IntentParams intentParams)

A constructor used to create an IntentParams instance by using the parameters of an existing IntentParams object.

参数:

intentParams - Indicates the existing IntentParams object.

从以下版本开始:

1

方法详细资料

getClassLoader

public ClassLoader getClassLoader()

Obtains the ClassLoader used for the custom parameters of the Sequenceable type.

返回:

Returns the ClassLoader object used.

从以下版本开始:

2

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Sets the ClassLoader used for the custom parameters of the Sequenceable type.

You should call this method before setting custom parameters of the Sequenceable type in an Intent.

参数:

classLoader - Indicates the ClassLoader object to set.

从以下版本开始:

2

另请参阅:

Intent.setParam(String, Sequenceable), Intent.setParam(String, Sequenceable[]), Intent.setSequenceableArrayListParam(String, ArrayList)

marshalling

public boolean marshalling(Parcel out)

Marshals an IntentParams object into a Parcel.

Key-value pairs in the IntentParams are marshalled separately. If any key-value pair fails to be marshalled, false is returned.

指定者:

marshalling 在接口中 Sequenceable

参数:

out - Indicates the Parcel object for marshalling.

返回:

Returns true if the marshalling is successful; returns false otherwise.

抛出:

IllegalArgumentException - Throws this exception if a parameter value is invalid.

从以下版本开始:

1

unmarshalling

public boolean unmarshalling(Parcel in)

Unmarshals an IntentParams object from a Parcel.

Key-value pairs in the IntentParams are unmarshalled separately. If any key-value pair fails to be unmarshalled, false is returned.

指定者:

unmarshalling 在接口中 Sequenceable

参数:

in - Indicates the Parcel object for unmarshalling.

返回:

Returns true if the unmarshalling is successful; returns false otherwise.

抛出:

IllegalArgumentException - Throws this exception if a parameter value is invalid.

从以下版本开始:

1

setParam

public <T> void setParam(String key,
                         T value)

Sets a parameter in key-value pair format.

类型参数:

T - Indicates the data type of the parameter value. It must be a child class of Object.

参数:

key - Indicates the key matching the parameter.

value - Indicates the value of the parameter.

从以下版本开始:

1

isEmpty

public boolean isEmpty()

Checks whether this IntentParams object contains no parameters.

返回:

Returns true if this object does not contain any parameters; returns false otherwise.

从以下版本开始:

3

size

public int size()

Obtains the number of parameters contained in this IntentParams object.

返回:

Returns the number of parameters.

从以下版本开始:

3

remove

public void remove(String key)

Removes the parameter matching the given key.

参数:

key - Indicates the key matching the parameter to be removed.

从以下版本开始:

3

getParam

public Object getParam(String key)

Obtains the parameter value based on a given key.

参数:

key - Indicates the key matching the parameter.

返回:

Returns the value matching the given key.

从以下版本开始:

1

hasParam

public boolean hasParam(String key)

Checks whether the Intent contains the given key.

参数:

key - Indicates the key to check.

返回:

Returns true if the Intent contains the key; returns false otherwise.

从以下版本开始:

1

keySet

public Set<String> keySet()

Obtains a set of the keys of all parameters.

返回:

Returns a set of keys.

从以下版本开始:

1