Module commonevent 

Available on crate features commonevent and api-12 only.

Structs

CommonEvent_ErrCode

Defines error codes.

CommonEvent_PublishInfoapi-18

the common event publish information containing content and attributes of the common event

CommonEvent_RcvData

the data of the commonEvent callback

CommonEvent_SubscribeInfo

the information of the subscriber

Functions

OH_CommonEvent_AbortCommonEvent^⚠api-18

Abort an ordered event by a subscriber.

OH_CommonEvent_ClearAbortCommonEvent^⚠api-18

Clear the aborted flag of an ordered event by a subscriber.

OH_CommonEvent_CreateParameters^⚠api-18

Create a common event publish information.

OH_CommonEvent_CreatePublishInfo^⚠api-18

Create a common event publish information.

OH_CommonEvent_CreateSubscribeInfo^⚠

Create subscribe information.

OH_CommonEvent_CreateSubscriber^⚠

Create a subscriber.

OH_CommonEvent_DestroyParameters^⚠api-18

Destroy the common event publish information.

OH_CommonEvent_DestroyPublishInfo^⚠api-18

Destroy the common event publish information.

OH_CommonEvent_DestroySubscribeInfo^⚠

Destroy the subscribe information.

OH_CommonEvent_DestroySubscriber^⚠

Destory the subscriber.

OH_CommonEvent_FinishCommonEvent^⚠api-18

Finish an ordered event by a subscriber.

OH_CommonEvent_GetAbortCommonEvent^⚠api-18

Check an event by a subscriber whether it is aborted.

OH_CommonEvent_GetBoolArrayFromParameters^⚠

Get bool array data from parameters data by key.

OH_CommonEvent_GetBoolFromParameters^⚠

Get bool data from parameters data by key.

OH_CommonEvent_GetBundleNameFromRcvData^⚠

Get event bundlename from callback data.

OH_CommonEvent_GetCharArrayFromParameters^⚠

Get char array data from parameters data by key.

OH_CommonEvent_GetCharFromParameters^⚠

Get char data from parameters data by key.

OH_CommonEvent_GetCodeFromRcvData^⚠

Get event code from callback data.

OH_CommonEvent_GetCodeFromSubscriber^⚠api-18

Get code from an ordered event by a subscriber.

OH_CommonEvent_GetDataFromSubscriber^⚠api-18

Get data from an ordered event by a subscriber.

OH_CommonEvent_GetDataStrFromRcvData^⚠

Get event data from callback data.

OH_CommonEvent_GetDoubleArrayFromParameters^⚠

Get double array data from parameters data by key.

OH_CommonEvent_GetDoubleFromParameters^⚠

Get double data from parameters data by key.

OH_CommonEvent_GetEventFromRcvData^⚠

Get event name from callback data.

OH_CommonEvent_GetIntArrayFromParameters^⚠

Get int array data from parameters data by key.

OH_CommonEvent_GetIntFromParameters^⚠

Get int data from parameters data by key.

OH_CommonEvent_GetLongArrayFromParameters^⚠

Get long array data from parameters data by key.

OH_CommonEvent_GetLongFromParameters^⚠

Get long data from parameters data by key.

OH_CommonEvent_GetParametersFromRcvData^⚠

Get event parameters data from callback data.

OH_CommonEvent_HasKeyInParameters^⚠

Check whether the parameters data contains a key.

OH_CommonEvent_IsOrderedCommonEvent^⚠api-18

Check an event by a subscriber whether it is ordered.

OH_CommonEvent_Publish^⚠api-18

Publish a commen event.

OH_CommonEvent_PublishWithInfo^⚠api-18

Publish a commen event with specified publish information.

OH_CommonEvent_SetBoolArrayToParameters^⚠api-18

Set bool array data to parameters data by key.

OH_CommonEvent_SetBoolToParameters^⚠api-18

Set bool data to parameters data by key.

OH_CommonEvent_SetCharArrayToParameters^⚠api-18

Set char array data to parameters data by key.

OH_CommonEvent_SetCharToParameters^⚠api-18

Set char data to parameters data by key.

OH_CommonEvent_SetCodeToSubscriber^⚠api-18

Set code to an ordered event by a subscriber.

OH_CommonEvent_SetDataToSubscriber^⚠api-18

Set data to an ordered event by a subscriber.

OH_CommonEvent_SetDoubleArrayToParameters^⚠api-18

Set double array data to parameters data by key.

OH_CommonEvent_SetDoubleToParameters^⚠api-18

Set double data to parameters data by key.

OH_CommonEvent_SetIntArrayToParameters^⚠api-18

Set int array data to parameters data by key.

OH_CommonEvent_SetIntToParameters^⚠api-18

Set int data to parameters data by key.

OH_CommonEvent_SetLongArrayToParameters^⚠api-18

Set long array data to parameters data by key.

OH_CommonEvent_SetLongToParameters^⚠api-18

Set long data to parameters data by key.

OH_CommonEvent_SetPublishInfoBundleName^⚠api-18

Set the bundleName of publish information.

OH_CommonEvent_SetPublishInfoCode^⚠api-18

Set the code of publish information.

OH_CommonEvent_SetPublishInfoData^⚠api-18

Set the data of publish information.

OH_CommonEvent_SetPublishInfoParameters^⚠api-18

Set the parameters of publish information.

OH_CommonEvent_SetPublishInfoPermissions^⚠api-18

Set the permissions of publish information.

OH_CommonEvent_SetPublisherBundleName^⚠

Set the bundleName of the subscribe information.

OH_CommonEvent_SetPublisherPermission^⚠

Set the permission of the subscribe information.

OH_CommonEvent_Subscribe^⚠

Subscribe event by a subscriber.

OH_CommonEvent_UnSubscribe^⚠

Unsubscribe event by a subscriber.

Type Aliases

CommonEvent_Parameters

The description of the parameters in a common event callback data.

CommonEvent_ReceiveCallback

Common event callback.

CommonEvent_Subscriber

the subscriber of common event