程序包 ohos.event.commonevent

类 AsyncCommonEventResult

java.lang.Object

ohos.event.commonevent.AsyncCommonEventResult

public final class AsyncCommonEventResult
extends Object

Encapsulates the asynchronous result of the current ordered common event.

An AsyncCommonEventResult object is returned by CommonEventSubscriber#goAsyncCommonEvent() in the CommonEventSubscriber#onReceiveEvent(CommonEventData) callback method. This allows your application to process the current common event on another thread instead of the main thread. However, this requires that your application call the finishCommonEvent() method when processing of the common event is complete.

从以下版本开始:

2

SystemCapability

SystemCapability.Notification#CES

方法概要

限定符和类型	方法	说明
void	abortCommonEvent()	Cancels the current ordered common event.
void	clearAbortCommonEvent()	Clears the abort state of the current ordered common event.
void	finishCommonEvent()	Finishes processing 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.
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.

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

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

方法详细资料

setCode

public void setCode(int code)

Sets the result code of the current ordered common event. This method is the version of CommonEventSubscriber#setCode(int) for asynchronous common event processing.

参数:

code - Indicates the custom result code to set. You can set it to any int value.

抛出:

IllegalArgumentException - Throws this exception if the current common event is not an ordered common event.

从以下版本开始:

2

getCode

public int getCode()

Obtains the result code of the current ordered common event. This method is the version of CommonEventSubscriber#getCode() for asynchronous common event processing.

返回:

Returns the result code of the current ordered common event.

从以下版本开始:

2

setData

public void setData(String data)

Sets the result data of the current ordered common event. This method is the version of CommonEventSubscriber#setData(String) for asynchronous common event processing.

参数:

data - Indicates the custom result data to set. You can set it to any character string.

抛出:

IllegalArgumentException - Throws this exception if the current common event is not an ordered common event.

从以下版本开始:

2

getData

public String getData()

Obtains the result data of the current ordered common event. This method is the version of CommonEventSubscriber#getData() for asynchronous common event processing.

返回:

Returns the result data of the current ordered common event.

从以下版本开始:

2

setCodeAndData

public void setCodeAndData(int code,
                           String data)

Sets the result of the current ordered common event. This method is the version of CommonEventSubscriber#setCodeAndData(int, String) for asynchronous common event processing.

参数:

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.

抛出:

IllegalArgumentException - Throws this exception if the current common event is not an ordered common event.

从以下版本开始:

2

abortCommonEvent

public void abortCommonEvent()

Cancels the current ordered common event. This method is the version of CommonEventSubscriber#abortCommonEvent() for asynchronous common event processing.

抛出:

IllegalArgumentException - Throws this exception if the current common event is not an ordered common event.

从以下版本开始:

2

getAbortCommonEvent

public boolean getAbortCommonEvent()

Checks whether the current ordered common event should be aborted. This method is the version of CommonEventSubscriber#getAbortCommonEvent() for asynchronous common event processing.

返回:

Returns true if the common event should be aborted; returns false otherwise.

从以下版本开始:

2

clearAbortCommonEvent

public void clearAbortCommonEvent()

Clears the abort state of the current ordered common event. This method is the version of CommonEventSubscriber#clearAbortCommonEvent() for asynchronous common event processing.

从以下版本开始:

2

finishCommonEvent

public void finishCommonEvent()

Finishes processing the current ordered common event. This method must be called after asynchronous processing is complete.

抛出:

IllegalArgumentException - Throws this exception if the current common event is not an ordered common event.

从以下版本开始:

2