aiwcommon.hrh File Reference

Always keep the provider menu items in a submenu.

Menu item is placed intelligently either to the main level or a submenu.

Consumer defines the menu title.

Criteria item loadOptions bit, only providers in ROM are accepted.

Event codes.

To be used with HandleNotifyL method.

Enumerator:

KAiwEventStarted	Asynchronous service informs consumer to prepare itself for action.
KAiwEventCompleted	Asynchronous service request completed.
KAiwEventCanceled	Asynchronous service request canceled.
KAiwEventError	Error during asynchronous service request.
KAiwEventOutParamCheck	Relates to KAiwOptOutParamCheck.
KAiwEventInParamCheck	Relates to KAiwOptInParamCheck.
KAiwEventStopped	Provider informs consumer that service is no longer available or has stopped.
KAiwEventQueryExit	Provider asks consumer whether Exit can be done (needed at least in embedded use cases where server application offers Exit possibility to end user, but consumer can not allow Exit due to fact that for example network connections owned by consumer are open and they need to be kept alive).

Service classes (UID).

Technically these are same as service interface UIDs.

Enumerator:

KAiwClassNone	None.
KAiwClassBase	Base service (no UI expected). Every other class must implement this always!
KAiwClassMenu	Menu service class (offers menu based services).

Service command options (bits) to alter command handling behaviour.

Enumerator:

KAiwOptASyncronous	Consumer wants asynchronous command handling. The default is synchronous command handling. In asynchronous case consumer needs to pass a callback to provider.
KAiwOptOutParamCheck	Consumer wants provider to make a callback to check coming output parameters prior returning from service command handling. Consumer needs to pass a callback to provider.
KAiwOptInParamCheck	Consumer tells provider that it is prepared to handle callback events for possibly incomplete/wrong parameter list.
KAiwOptCancel	Consumer wants to cancel an asynchronous AIW service. When a consumer wants to cancel the asynchronous service that a provider is executing, it should call ExecuteMenuCmdL() or ExecuteServiceCmdL() with the same parameters as when requesting the service, but set this cancel bit on. The cancel operation itself is synchronous, i.e. the provider must call the consumer's callback with KAiwEventCanceled before the Execute*CmdL() returns.

Predefined service commands (UIDs).

Enumerator:

KAiwCmdNone	Null value.
KAiwCmdHelp	Show help content.
KAiwCmdMnShowMap	Client can request that map should be displayed on screen.
KAiwCmdMnNavigateTo	Allows to start navigation to desired destination.
KAiwCmdMnAddrByCoord	Starts reverse geocoding request: finding address for given coordinate.
KAiwCmdMnCoordByAddr	Starts geocoding request: finding coordinate by given address.
KAiwCmdMnSelectFromMap	Allows client to request that user shall select a location from map.