程序包 ohos.event.commonevent

类 CommonEventData

java.lang.Object

ohos.event.commonevent.CommonEventData

所有已实现的接口:

Sequenceable

public final class CommonEventData
extends Object
implements Sequenceable

Carries common events, for example, publishing common event contents and storing common events received after subscription.

To publish a common event, call the CommonEventData(ohos.aafwk.content.Intent) or CommonEventData(ohos.aafwk.content.Intent,int,java.lang.String) method to initialize the Intent attribute, set Action and IntentParams of the common event based on Intent, and then use the CommonEventManager#publishCommonEvent(CommonEventData) method with CommonEventData as the input parameter to finish the publishing. To subscribe to a common event, you need to inherit the class CommonEventSubscriber and override the CommonEventSubscriber#onReceiveEvent(CommonEventData) callback method. After a common event is received, CommonEventData stores the received common event object.

从以下版本开始:

1

SystemCapability

SystemCapability.Notification#CES

嵌套类概要

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

Sequenceable.Producer<T>

字段概要

字段

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

构造器概要

构造器

构造器	说明
CommonEventData()	Default constructor used to create an empty CommonEventData instance.
CommonEventData(Intent intent)	Creates a CommonEventData instance based on the intent parameter to set the content of a common event.
CommonEventData(Intent intent, int code, String data)	Creates a CommonEventData instance based on the parameters intent, code, and data to set the content of the common event.

方法概要

限定符和类型	方法	说明
int	getCode()	Obtains the result code of a common event.
String	getData()	Obtains the result data of a common event, which is set by setData(java.lang.String).
Intent	getIntent()	Obtains the Intent attribute of a common event.
boolean	marshalling(Parcel out)	Marshals a CommonEventData object into a Parcel.
void	setCode(int code)	Sets the result code of the common event.
void	setData(String data)	Sets the result data of a common event.
String	toString()	Returns a string representation of the object.
boolean	unmarshalling(Parcel in)	Unmarshals a CommonEventData object from a Parcel.

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

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

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

hasFileDescriptor

字段详细资料

PRODUCER

public static final Sequenceable.Producer<CommonEventData> PRODUCER

Creates a CommonEventData instance from a Parcel.

从以下版本开始:

4

构造器详细资料

CommonEventData

public CommonEventData()

Default constructor used to create an empty CommonEventData instance.

从以下版本开始:

1

CommonEventData

public CommonEventData(Intent intent)

Creates a CommonEventData instance based on the intent parameter to set the content of a common event.

参数:

intent - Indicates the Intent object used to set the common event content. This parameter is mandatory. Not allowed to be null, otherwise common event publish fails.

从以下版本开始:

1

另请参阅:

Intent

CommonEventData

public CommonEventData(Intent intent,
                       int code,
                       String data)

Creates a CommonEventData instance based on the parameters intent, code, and data to set the content of the common event.

参数:

intent - Indicates the Intent object used to set the common event content. This parameter is mandatory.

code - Indicates the custom result code of the common event. The value of code is generally -1. You can set it to any int value. This parameter is only applicable to ordered common events and is optional.

data - Indicates the custom result data of the common event. The value of data is generally null. You can set it to any character string. This parameter is only applicable to ordered common events and is optional.

从以下版本开始:

1

另请参阅:

Intent

方法详细资料

getIntent

public Intent getIntent()

Obtains the Intent attribute of a common event.

返回:

Returns the Intent attribute of the common event.

从以下版本开始:

1

setCode

public void setCode(int code)

Sets the result code of the common event.

参数:

code - Indicates the custom result code of the common event. You can set it to any int value. This parameter is optional.

从以下版本开始:

1

getCode

public int getCode()

Obtains the result code of a common event. The result code is set by calling setCode(int).

返回:

Returns the result code of the common event.

从以下版本开始:

1

setData

public void setData(String data)

Sets the result data of a common event.

参数:

data - Indicates the custom result data of the common event. You can set it to any character string. This parameter is optional.

从以下版本开始:

1

getData

public String getData()

Obtains the result data of a common event, which is set by setData(java.lang.String).

返回:

Returns the result data of the common event.

从以下版本开始:

1

marshalling

public boolean marshalling(Parcel out)

Marshals a CommonEventData object into a Parcel.

A process can call the unmarshalling(ohos.utils.Parcel) method to unmarshal a CommonEventData object from a Parcel to implement inter-process communication (IPC).

指定者:

marshalling 在接口中 Sequenceable

参数:

out - Indicates the Parcel object for marshalling.

返回:

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

从以下版本开始:

1

unmarshalling

public boolean unmarshalling(Parcel in)

Unmarshals a CommonEventData object from a Parcel.

指定者:

unmarshalling 在接口中 Sequenceable

参数:

in - Indicates the Parcel object for unmarshalling.

返回:

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

从以下版本开始:

1

toString

public String toString()

从类复制的说明: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

覆盖:

toString 在类中 Object

返回:

a string representation of the object.

从以下版本开始:

4