CommonEventSubscribeInfo

java.lang.Object
- ohos.event.commonevent.CommonEventSubscribeInfo

所有已实现的接口:

Sequenceable
```
public final class CommonEventSubscribeInfo
extends Object
implements Sequenceable
```
Sets filter criteria of publishers, such as the device ID and permission, for subscribing to desired common events.
After you set the filter criteria in a CommonEventSubscribeInfo object, you can pass it to the CommonEventManager#subscribeCommonEvent(CommonEventSubscriber) or CommonEventManager#unsubscribeCommonEvent(CommonEventSubscriber) method to subscribe to or unsubscribe from common events only from publishers meeting the filter criteria.
For an ordered common event (common event that has a sending order), you can use the setPriority(int) method to set the subscriber priority, and the ordered common event will be sent first to a subscriber with a higher priority. Additionally, you can call setThreadMode(ohos.event.commonevent.CommonEventSubscribeInfo.ThreadMode) to specify the thread to run the callback method. For details, see ThreadMode.

从以下版本开始:

1

SystemCapability

SystemCapability.Notification#CES

嵌套类概要

嵌套类
限定符和类型	类	说明
`static class`	`CommonEventSubscribeInfo.ThreadMode`	Specifies the thread mode so that the callback method of the subscriber runs on the specified thread.

从接口继承的嵌套类/接口 ohos.utils.Sequenceable
Sequenceable.Producer<T>

字段概要

字段
限定符和类型字段说明

static Sequenceable.Producer<CommonEventSubscribeInfo> PRODUCER
Creates a CommonEventSubscribeInfo instance from a Parcel.

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

构造器概要

构造器
构造器	说明
`CommonEventSubscribeInfo(CommonEventSubscribeInfo subscribeInfo)`	A constructor used to create a `CommonEventSubscribeInfo` instance by copying parameters from an existing one.
`CommonEventSubscribeInfo(MatchingSkills matchingSkills)`	A constructor used to create a `CommonEventSubscribeInfo` instance with the `matchingSkills` parameters passed.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`String`	`getDeviceId()`	Obtains the device ID in this `CommonEventSubscribeInfo` object.
`MatchingSkills`	`getMatchingSkills()`	Obtains the `MatchingSkills` object carried in this `CommonEventSubscribeInfo` object.
`String`	`getPermission()`	Obtains the publisher permission of this `CommonEventSubscribeInfo` object.
`int`	`getPriority()`	Obtains the subscriber priority of this `CommonEventSubscribeInfo` object.
`CommonEventSubscribeInfo.ThreadMode`	`getThreadMode()`	Obtains the thread mode of this `CommonEventSubscribeInfo` object.
`boolean`	`marshalling(Parcel out)`	Marshals a `CommonEventSubscribeInfo` object into a `Parcel`.
`void`	`setDeviceId(String deviceId)`	Sets the device ID for this `CommonEventSubscribeInfo` object.
`void`	`setPermission(String permission)`	Sets the permission that the publisher must have in order to send a common event to this subscriber.
`void`	`setPriority(int priority)`	Sets the subscriber priority for this `CommonEventSubscribeInfo` object.
`void`	`setThreadMode(CommonEventSubscribeInfo.ThreadMode threadMode)`	Sets the thread mode of this `CommonEventSubscribeInfo` object.
`String`	`toString()`	Returns a string representation of the object.
`boolean`	`unmarshalling(Parcel in)`	Unmarshals a `CommonEventSubscribeInfo` 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<CommonEventSubscribeInfo> PRODUCER
```
    Creates a CommonEventSubscribeInfo instance from a Parcel.
    
    从以下版本开始:
    
    4
- 构造器详细资料
  - CommonEventSubscribeInfo
```
public CommonEventSubscribeInfo(MatchingSkills matchingSkills)
```
    A constructor used to create a CommonEventSubscribeInfo instance with the matchingSkills parameters passed.
    
    参数:
    
    matchingSkills - Indicates the MatchingSkills object to be set. This object is used to match the Intent object carried in a CommonEventData object.
    
    从以下版本开始:
    
    4
  - CommonEventSubscribeInfo
```
public CommonEventSubscribeInfo(CommonEventSubscribeInfo subscribeInfo)
```
    A constructor used to create a CommonEventSubscribeInfo instance by copying parameters from an existing one.
    
    参数:
    
    subscribeInfo - Indicates the CommonEventSubscribeInfo object.
    
    从以下版本开始:
    
    1
- 方法详细资料
  - getMatchingSkills
```
public MatchingSkills getMatchingSkills()
```
    Obtains the MatchingSkills object carried in this CommonEventSubscribeInfo object.
    
    返回:
    
    Returns the MatchingSkills object.
    
    从以下版本开始:
    
    4
  - getThreadMode
```
public CommonEventSubscribeInfo.ThreadMode getThreadMode()
```
    Obtains the thread mode of this CommonEventSubscribeInfo object. The thread mode is set by calling setThreadMode(ohos.event.commonevent.CommonEventSubscribeInfo.ThreadMode).
    
    返回:
    
    Returns the thread mode.
    
    从以下版本开始:
    
    1
  - setThreadMode
```
public void setThreadMode(CommonEventSubscribeInfo.ThreadMode threadMode)
```
    Sets the thread mode of this CommonEventSubscribeInfo object. The thread mode specifies the thread to run the callback method for the subscriber.
    
    参数:
    
    threadMode - Indicates the thread mode to be set, which is specified in ThreadMode. Currently, only the HANDLER mode is supported.
    
    从以下版本开始:
    
    1
  - getPermission
```
public String getPermission()
```
    Obtains the publisher permission of this CommonEventSubscribeInfo object. The permission is set by calling setPermission(java.lang.String).
    
    返回:
    
    Returns the permission information.
    
    从以下版本开始:
    
    1
  - setPermission
```
public void setPermission(String permission)
```
    Sets the permission that the publisher must have in order to send a common event to this subscriber. This subscriber receives only common events sent by publishers granted with this permission.
    
    参数:
    
    permission - Indicates the publisher permission to be set. This parameter is optional. If it is specified, the value must be a permission that has been defined in the system.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    CommonEventPublishInfo.setSubscriberPermissions(String[])
  - setDeviceId
```
public void setDeviceId(String deviceId)
```
    Sets the device ID for this CommonEventSubscribeInfo object. Your application will only receive common events sent from the specified device.
    
    参数:
    
    deviceId - Indicates the device ID. The value must be an existing device ID on the same ohos network. Otherwise, it is invalid.
    
    从以下版本开始:
    
    3
  - getDeviceId
```
public String getDeviceId()
```
    Obtains the device ID in this CommonEventSubscribeInfo object. The device ID is set by calling setDeviceId(java.lang.String).
    
    返回:
    
    Returns the device ID.
    
    从以下版本开始:
    
    3
  - setPriority
```
public void setPriority(int priority)
```
    Sets the subscriber priority for this CommonEventSubscribeInfo object. This method is used only for ordered common events. Subscribers with a higher priority will receive such events first.
    
    参数:
    
    priority - Indicates the subscriber priority. The value ranges from -100 to 1000.
    
    从以下版本开始:
    
    1
  - getPriority
```
public int getPriority()
```
    Obtains the subscriber priority of this CommonEventSubscribeInfo object. The priority is set by calling setPriority(int).
    
    返回:
    
    Returns the priority.
    
    从以下版本开始:
    
    1
  - marshalling
```
public boolean marshalling(Parcel out)
```
    Marshals a CommonEventSubscribeInfo object into a Parcel.
    A process can call the unmarshalling(ohos.utils.Parcel) method to unmarshal a CommonEventSubscribeInfo 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 CommonEventSubscribeInfo 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

类 CommonEventSubscribeInfo

嵌套类概要

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

字段概要

构造器概要

方法概要

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

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

字段详细资料

PRODUCER

构造器详细资料

CommonEventSubscribeInfo

CommonEventSubscribeInfo

方法详细资料

getMatchingSkills

getThreadMode

setThreadMode

getPermission

setPermission

setDeviceId

getDeviceId

setPriority

getPriority

marshalling

unmarshalling

toString