#include <mw/lbtlisttriggeroptions.h>
| class CLbtListTriggerOptions : public CBase |
| Public Member Enumerations | |
|---|---|
| enum | TLbtListTriggerSorting { ELbtNoSorting, ELbtTriggerNameAscending, ELbtTriggerNameDescending, ELbtDistanceToLatestLocationAscending } |
| Public Member Functions | |
|---|---|
| ~CLbtListTriggerOptions() | |
| IMPORT_C void | ExternalizeL(RWriteStream &) |
| IMPORT_C CLbtTriggerFilterBase * | Filter() |
| IMPORT_C void | GetRetrievedFields(TLbtTriggerAttributeFieldsMask &, TLbtTriggerDynamicInfoFieldsMask &) |
| IMPORT_C void | InternalizeL(RReadStream &) |
| IMPORT_C CLbtListTriggerOptions * | NewL() |
| IMPORT_C CLbtListTriggerOptions * | NewLC() |
| IMPORT_C void | SetFilter(CLbtTriggerFilterBase *) |
| IMPORT_C void | SetRetrievedFields(TLbtTriggerAttributeFieldsMask, TLbtTriggerDynamicInfoFieldsMask) |
| IMPORT_C void | SetSortingOption(TLbtListTriggerSorting) |
| IMPORT_C TLbtListTriggerSorting | SortingOption() |
Helper class for options used when listing trigger entries from Location Triggering Server.
The following options can be set.
Retrieved fields. It specifies what trigger entry attributes field and trigger dynamic information field shall be filled in the returned trigger objects. Default value for trigger entry attribute field is KLbtTriggerAttributeFieldsAll, which means all attributes field shall be filled. Whether the Trigger ID field is specified or not, the trigger ID attribute is always valid in returned trigger objects. Default value for trigger dynamic information field is KLbtTriggerDynInfoFieldsAll, which means all dynamic information fields will be filled.
Trigger filter. It specifies the filter used in retrieving trigger entries. Retrieved triggers shall fulfill the criteria defined in the filter. By default, the option does not contain a filter and all triggers will be retrieved. A composite filter can also be used.
Sorting option. It specifies in which order the retrieved trigger shall be sorted. The default value is ELbtNoSorting.
Sorting order when retrieving triggers from Location Triggering Server.
| IMPORT_C void | ExternalizeL | ( | RWriteStream & | aStream | ) | const |
Externalizes the trigger condition object's details and attributes to stream.
The presence of this function means that the standard templated operator<<() ( defined in s32strm.h ) is available to externalize objects of this class.
| Parameter | Description |
|---|---|
| aStream | Stream to which the object should be externalized. |
| IMPORT_C CLbtTriggerFilterBase * | Filter | ( | ) |
Gets pointer to the filter used for listing triggers. The function returns NULL if the filter is not previously set.
Returns: The filter used for listing triggers. Ownership of the returned object is not transferred to the client application.
| IMPORT_C void | GetRetrievedFields | ( | TLbtTriggerAttributeFieldsMask & | aEntryMask, |
| TLbtTriggerDynamicInfoFieldsMask & | aDynInfoMask | |||
| ) | const | |||
Gets the fields that Location Triggering Server will fill when list triggers
If the entry fields mask and dynamic information field mask is not set before, KLbtTriggerAttributeFieldsAll and KLbtTriggerDynInfoFieldsAll are returned.
| Parameter | Description |
|---|---|
| aEntryMask | On return contains the field mask defines which trigger entry fields shall be filled. |
| aDynInfoMask | On return contains the field mask defines which trigger dynamic information field shall be filled. |
| IMPORT_C void | InternalizeL | ( | RReadStream & | aStream | ) |
Internalizes the trigger condition object's details and attributes from stream.
The presence of this function means that the standard templated operator>>() ( defined in s32strm.h ) is available to internalize objects of this class.
| Parameter | Description |
|---|---|
| aStream | Stream from which the object should be internalized. |
| IMPORT_C CLbtListTriggerOptions * | NewL | ( | ) | [static] |
Constructs a new instance of trigger listing option object. In the returned object, retrieved fields is set to KLbtTriggerAttributeFieldsAll and KLbtTriggerDynInfoFieldsAll, no trigger filters is set and sorting option is set to ELbtNoSorting.
Returns: Pointer to the new instance of the trigger retrieving option object.
| IMPORT_C CLbtListTriggerOptions * | NewLC | ( | ) | [static] |
Constructs a new instance of trigger listing option object and pushes it onto cleanup stack. In the returned object, retrieved fields is set to KLbtTriggerAttributeFieldsAll and KLbtTriggerDynInfoFieldsAll, no trigger filters is set and sorting option is set to ELbtNoSorting.
Returns: Pointer to the new instance of the trigger retrieving option object.
| IMPORT_C void | SetFilter | ( | CLbtTriggerFilterBase * | aFilter | ) |
Sets the filter used for listing triggers.
| Parameter | Description |
|---|---|
| aFilter | Pointer to the filter used for listing triggers. If the pointer is NULL, previous set filter is deleted. Ownership of aFilter is transferred to the client application. |
| IMPORT_C void | SetRetrievedFields | ( | TLbtTriggerAttributeFieldsMask | aEntryMask, |
| TLbtTriggerDynamicInfoFieldsMask | aDynInfoMask = KLbtTriggerDynInfoFieldsAll | |||
| ) | ||||
Sets which fields shall be filled by Location Triggering Server when listing triggers.
| Parameter | Description |
|---|---|
| aEntryMask | Mask defines which trigger entry fields shall be filled. |
| aDynInfoMask | The mask defines which dynamic information field shall be filled. |
| IMPORT_C void | SetSortingOption | ( | TLbtListTriggerSorting | aOption | ) |
Sets the sorting option when listing triggers.
| Parameter | Description |
|---|---|
| aOption | The sorting option when retrieving triggers. |
| IMPORT_C TLbtListTriggerSorting | SortingOption | ( | ) | const |
Gets the sorting option when listing triggers. This function returns ELbtNoSorting if the sorting option has not been set.
Returns: The sorting option when listing triggers.