CommonEventSubscriber

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

```
public abstract class CommonEventSubscriber
extends Object
```
Provides methods that will be called back when a subscriber receives a new common event.
CommonEventSubscriber is an abstract class. If you want your application to receive common events from other applications, you must first inherit this class and implement the onReceiveEvent(ohos.event.commonevent.CommonEventData) method. Then, you can use methods provided in CommonEventManager to subscribe to or unsubscribe from certain common events. The received common events will be stored in CommonEventData.

从以下版本开始:

1

另请参阅:

CommonEventManager.subscribeCommonEvent(CommonEventSubscriber), CommonEventManager.unsubscribeCommonEvent(CommonEventSubscriber)

SystemCapability

SystemCapability.Notification#CES

构造器概要

构造器
构造器	说明
`CommonEventSubscriber(CommonEventSubscribeInfo subscribeInfo)`	A constructor used to create a `CommonEventSubscriber` instance with the `subscribeInfo` parameter passed.

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法	说明
`void`	`abortCommonEvent()`	Aborts the current ordered common event.
`void`	`clearAbortCommonEvent()`	Clears the abort state of the current ordered common event.
`boolean`	`getAbortCommonEvent()`	Checks whether the current ordered common event should be aborted.
`int`	`getCode()`	Obtains the result code of the current ordered common event.
`String`	`getData()`	Obtains the result data of the current ordered common event.
`IRemoteObject`	`getRemoteAbility(Context zContext, Intent zIntent)`	Obtains an `IRemoteObject` object bound to a specified ability.
`CommonEventSubscribeInfo`	`getSubscribeInfo()`	Obtains the current `CommonEventSubscribeInfo` object, which is passed in the constructor.
`AsyncCommonEventResult`	`goAsyncCommonEvent()`	Enables asynchronous processing for the current ordered common event.
`boolean`	`isOrderedCommonEvent()`	Checks whether the current common event is an ordered common event.
`boolean`	`isStickyCommonEvent()`	Checks whether the current common event is a sticky common event.
`abstract void`	`onReceiveEvent(CommonEventData data)`	Called back when the application receives a new common event.
`void`	`setCode(int code)`	Sets the result code of the current ordered common event.
`void`	`setCodeAndData(int code, String data)`	Sets the result of the current ordered common event.
`void`	`setData(String data)`	Sets the result data of the current ordered common event.
`String`	`toString()`	Returns a string representation of the object.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - CommonEventSubscriber
```
public CommonEventSubscriber(CommonEventSubscribeInfo subscribeInfo)
```
    A constructor used to create a CommonEventSubscriber instance with the subscribeInfo parameter passed.
    
    参数:
    
    subscribeInfo - Indicates the CommonEventSubscribeInfo object to set.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if subscribeInfo is null.
    
    从以下版本开始:
    
    1
- 方法详细资料
  - onReceiveEvent
```
public abstract void onReceiveEvent(CommonEventData data)
```
    Called back when the application receives a new common event.
    If you want to subscribe to and receive common events from other applications, you should inherit the CommonEventSubscriber class and override this method.
    
    参数:
    
    data - Indicates the received CommonEventData object.
    
    从以下版本开始:
    
    1
  - getSubscribeInfo
```
public CommonEventSubscribeInfo getSubscribeInfo()
```
    Obtains the current CommonEventSubscribeInfo object, which is passed in the constructor.
    
    返回:
    
    Returns the current CommonEventSubscribeInfo object.
    
    从以下版本开始:
    
    1
  - goAsyncCommonEvent
```
public final AsyncCommonEventResult goAsyncCommonEvent()
```
    Enables asynchronous processing for the current ordered common event.
    This method is called using the onReceiveEvent(ohos.event.commonevent.CommonEventData) callback method. The common event remains active after being returned from onReceiveEvent(ohos.event.commonevent.CommonEventData). That is, the common event can continue to perform its time-consuming operations on another thread instead of the main thread. However, this does not mean that time-consuming operations can be executed by calling the callback method. In addition, your application is required to call AsyncCommonEventResult#finishCommonEvent() to finish processing the ordered common event before it is complete.
    
    返回:
    
    Returns the asynchronous result of the current ordered common event.
    
    从以下版本开始:
    
    2
  - setCode
```
public final void setCode(int code)
```
    Sets the result code of the current ordered common event.
    This method takes effect only for ordered common events. You can call CommonEventPublishInfo#setOrdered(boolean) with the input parameter set to true to set a common event ordered. The next subscriber will receive the result code after the code is set.
    
    参数:
    
    code - Indicates the custom result code to set. You can set it to any int value.
    
    从以下版本开始:
    
    2
  - getCode
```
public final int getCode()
```
    Obtains the result code of the current ordered common event.
    
    返回:
    
    Returns the result code of the current ordered common event.
    
    从以下版本开始:
    
    2
  - setData
```
public final void setData(String data)
```
    Sets the result data of the current ordered common event.
    This method takes effect only for ordered common events. You can call CommonEventPublishInfo#setOrdered(boolean) with the input parameter set to true to set a common event ordered.
    
    参数:
    
    data - Indicates the custom result data to set. You can set it to any character string.
    
    从以下版本开始:
    
    2
  - getData
```
public final String getData()
```
    Obtains the result data of the current ordered common event. The result data can be set by the previous common event subscriber, but it is usually null.
    
    返回:
    
    Returns the result data of the current ordered common event.
    
    从以下版本开始:
    
    2
  - setCodeAndData
```
public final void setCodeAndData(int code,
                                 String data)
```
    Sets the result of the current ordered common event.
    This method takes effect only for ordered common events. You can call CommonEventPublishInfo#setOrdered(boolean) with the input parameter set to true to set a common event ordered.
    
    参数:
    
    code - Indicates the custom result code to set. You can set it to any int value.
    
    data - Indicates the custom result data to set. You can set it to any character string.
    
    从以下版本开始:
    
    2
  - abortCommonEvent
```
public final void abortCommonEvent()
```
    Aborts the current ordered common event.
    This method takes effect only for ordered common events. Once this method is called, no subscribers will receive this common event. You can call clearAbortCommonEvent() to revoke this operation.
    
    从以下版本开始:
    
    2
  - getAbortCommonEvent
```
public final boolean getAbortCommonEvent()
```
    Checks whether the current ordered common event should be aborted.
    
    返回:
    
    Returns true if the current common event should be aborted; returns false otherwise.
  - clearAbortCommonEvent
```
public final void clearAbortCommonEvent()
```
    Clears the abort state of the current ordered common event. After this method is called, getAbortCommonEvent() will return false.
    
    从以下版本开始:
    
    2
  - getRemoteAbility
```
public IRemoteObject getRemoteAbility(Context zContext,
                                      Intent zIntent)
                               throws RemoteException
```
    Obtains an IRemoteObject object bound to a specified ability. The ability must have been started via Ability.connectAbility(Intent, IAbilityConnection) before this method is called. You are advised to call this method in onReceiveEvent(CommonEventData) to obtain an IRemoteObject object that is bound to a started ability.
    
    参数:
    
    zContext - Indicates the Context object of the current application.
    
    zIntent - Indicates information about the ability that has been started.
    
    返回:
    
    Returns the IRemoteObject bound to the specified ability.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    从以下版本开始:
    
    4
  - isOrderedCommonEvent
```
public final boolean isOrderedCommonEvent()
```
    Checks whether the current common event is an ordered common event.
    
    返回:
    
    Returns true if it is an ordered common event; returns false otherwise.
    
    从以下版本开始:
    
    2
  - isStickyCommonEvent
```
public final boolean isStickyCommonEvent()
```
    Checks whether the current common event is a sticky common event.
    
    返回:
    
    Returns true if it is a sticky common event; returns false otherwise.
    
    从以下版本开始:
    
    2
  - 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

类 CommonEventSubscriber

构造器概要

方法概要

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

构造器详细资料

CommonEventSubscriber

方法详细资料

onReceiveEvent

getSubscribeInfo

goAsyncCommonEvent

setCode

getCode

setData

getData

setCodeAndData

abortCommonEvent

getAbortCommonEvent

clearAbortCommonEvent

getRemoteAbility

isOrderedCommonEvent

isStickyCommonEvent

toString