程序包 ohos.event.commonevent

类 CommonEventPublishInfo

java.lang.Object

ohos.event.commonevent.CommonEventPublishInfo

所有已实现的接口:

Sequenceable

public final class CommonEventPublishInfo
extends Object
implements Sequenceable

Provides information for publishing common events, including setting subscriber filter criteria, common event type and mode.

If you call the CommonEventManager#publishCommonEvent(CommonEventData, CommonEventPublishInfo) or CommonEventManager#publishCommonEvent(CommonEventData, CommonEventPublishInfo, CommonEventSubscriber) method to publish a common event, you can publish the common event only to related subscribers by setting the filter criteria, including the user ID and permissions.

If you call the setOrdered(boolean) method with a value of true, an ordered common event will be published. If you call the setSticky(boolean) method with a value of true, a sticky common event will be published. If you call either of the two methods with a value of false, a standard common event will be published by default. You can allow only specified subscribers to receive a common event by calling the setSubscriberPermissions(java.lang.String[]) method.

从以下版本开始:

1

另请参阅:

CommonEventManager.publishCommonEvent(CommonEventData, CommonEventPublishInfo), CommonEventManager.publishCommonEvent(CommonEventData, CommonEventPublishInfo, CommonEventSubscriber)

SystemCapability

SystemCapability.Notification#CES

嵌套类概要

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

Sequenceable.Producer<T>

字段概要

字段

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

构造器概要

构造器

构造器	说明
CommonEventPublishInfo()	Default constructor used to create an empty CommonEventPublishInfo instance.
CommonEventPublishInfo(CommonEventPublishInfo publishInfo)	A constructor used to create a CommonEventPublishInfo instance by copying parameters from an existing one.

方法概要

限定符和类型	方法	说明
String[]	getSubscriberPermissions()	Obtains subscriber permissions to a common event, which can be set by setSubscriberPermissions(java.lang.String[]).
boolean	isOrdered()	Obtains whether it is an ordered common event, which can be set by setOrdered(boolean).
boolean	isSticky()	Obtains whether it is a sticky common event, which can be set by setSticky(boolean).
boolean	marshalling(Parcel out)	Marshals a CommonEventPublishInfo object into a Parcel.
void	setOrdered(boolean ordered)	Sets whether the type of a common event is ordered or not.
void	setSticky(boolean sticky)	Sets whether the type of a common event is sticky or not.
void	setSubscriberPermissions(String[] subscriberPermissions)	Sets permissions for subscribers.
String	toString()	Returns a string representation of the object.
boolean	unmarshalling(Parcel in)	Unmarshals a CommonEventPublishInfo 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<CommonEventPublishInfo> PRODUCER

Creates a CommonEventPublishInfo instance from a Parcel.

从以下版本开始:

4

构造器详细资料

CommonEventPublishInfo

public CommonEventPublishInfo()

Default constructor used to create an empty CommonEventPublishInfo instance.

从以下版本开始:

1

CommonEventPublishInfo

public CommonEventPublishInfo(CommonEventPublishInfo publishInfo)

A constructor used to create a CommonEventPublishInfo instance by copying parameters from an existing one.

参数:

publishInfo - Indicates the CommonEventPublishInfo object.

从以下版本开始:

1

方法详细资料

setSticky

public void setSticky(boolean sticky)

Sets whether the type of a common event is sticky or not.

A sticky common event can be received by subscribers immediately after subscription. You are advised not to set a common event to be sticky.

参数:

sticky - Specifies whether the common event is sticky. The value true indicates sticky and the value false indicates standard.

从以下版本开始:

1

isSticky

public boolean isSticky()

Obtains whether it is a sticky common event, which can be set by setSticky(boolean).

返回:

Returns true if the common event is sticky; returns false otherwise.

从以下版本开始:

1

setOrdered

public void setOrdered(boolean ordered)

Sets whether the type of a common event is ordered or not.

An ordered common event is received by subscribers in descending priority. Specifically, a highest-priority subscriber receives the event, then high-priority subscribers, and finally low-priority subscribers. priority limit -1000~1000 and the highest priority is 1000.

参数:

ordered - Specifies whether the common event is ordered. The value true indicates ordered and the value false indicates standard.

从以下版本开始:

1

isOrdered

public boolean isOrdered()

Obtains whether it is an ordered common event, which can be set by setOrdered(boolean).

返回:

Returns true if the common event is ordered; returns false otherwise.

从以下版本开始:

1

setSubscriberPermissions

public void setSubscriberPermissions(String[] subscriberPermissions)

Sets permissions for subscribers. Only subscribers with required permissions can receive published common events.

Currently, only one permission can be set for subscribers. If multiple permissions are specified in subscriberPermissions, only the first one takes effect.

参数:

subscriberPermissions - Indicates the permissions to be set. This parameter is optional. If it is specified, the value must be permissions that have been defined in the system.

从以下版本开始:

1

getSubscriberPermissions

public String[] getSubscriberPermissions()

Obtains subscriber permissions to a common event, which can be set by setSubscriberPermissions(java.lang.String[]).

返回:

Returns the subscriber permissions.

从以下版本开始:

1

marshalling

public boolean marshalling(Parcel out)

Marshals a CommonEventPublishInfo object into a Parcel.

A process can call the unmarshalling(ohos.utils.Parcel) method to unmarshal a CommonEventPublishInfo 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 CommonEventPublishInfo 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