Symbian^3 Application Developer Library >

mpxcollectioncommanddefs.h File Reference

const TInt KMPXCommandIdCollectionRetrieveUriForDeletion

const TInt KMPXCommandIdCollectionRetrieveUriForDeletion

Content ID identifying sync. command to retrieve URIs of the medias from the path for file deletion. If a client is required to delete the associated file before removing the media from the collection, this command can be used. A list of URIs associated with the path will be returned. If the given path ends with a media or medias in a particular playlist, the returned URI array will contain 0 element since client won't want to delete the associated song files in this case.

const TMPXAttributeData KMPXCommandCollectionRetrievePath

const TMPXAttributeData KMPXCommandCollectionRetrievePath

Attributes supported for KMPXCommandIdCollectionRetrieveUriForDeletion CMPXCollectionPath , collection path (in/out param). The collection path to be used for searching. If the path ends at a particular artist/album/genre/composer, the path will be expended to include all the songs under category selected.

const TMPXAttributeData KMPXCommandCollectionRetrieveUriError

const TMPXAttributeData KMPXCommandCollectionRetrieveUriError

TInt, error code (out param)

const TMPXAttributeData KMPXCommandCollectionRetrieveMediaUriArray

const TMPXAttributeData KMPXCommandCollectionRetrieveMediaUriArray

CDesCArray, an array of URIs associated with the given collection path. (out param)

const TInt KMPXCommandIdCollectionRemove

const TInt KMPXCommandIdCollectionRemove

Content ID identifying incremental sync. Remove command

const TMPXAttributeData KMPXCommandCollectionRemovePath

const TMPXAttributeData KMPXCommandCollectionRemovePath

Attributes supported for KMPXCommandIdCollectionRemove CMPXCollectionPath , collection path (in/out param). The path to remove from the collection. Upon return, an updated path is returned so it can be used for the next iteration.

const TMPXAttributeData KMPXCommandCollectionRemoveMediaCount

const TMPXAttributeData KMPXCommandCollectionRemoveMediaCount

TInt, indicates how many media to remove in one command (in param) 0 or a negative value means to delete all in one go

const TMPXAttributeData KMPXCommandCollectionRemoveError

const TMPXAttributeData KMPXCommandCollectionRemoveError

TInt, error code (out param)

const TMPXAttributeData KMPXCommandCollectionRemoveCompleted

const TMPXAttributeData KMPXCommandCollectionRemoveCompleted

TBool, completed (out param), indicates whether the client should make further removal request

const TMPXAttributeData KMPXCommandCollectionRemoveSuppressMsgs

const TMPXAttributeData KMPXCommandCollectionRemoveSuppressMsgs

TBool, indicate if we should supporess collection change messages Changes will be added to EMPXCommandCollectionChangeMsgs

const TMPXAttributeData KMPXCommandCollectionChangeMsgs

const TMPXAttributeData KMPXCommandCollectionChangeMsgs

CMPXMessageArray to store collection messages

const TInt KMPXCommandIdCollectionRemoveMedia

const TInt KMPXCommandIdCollectionRemoveMedia

Content ID identifying sync. Remove Media command. The identified media will be deleted from the collection database instead of being marked as deleted if client explictly requests to delete the records; otherwise, whether the records will be deleted or marked as deleted will be based on other factors (e.g. whether MTP is supported, if so, the 1st X records will be marked as deleted; thereafter, they will be deleted).

const TMPXAttributeData KMPXCommandCollectionRemoveMedia

const TMPXAttributeData KMPXCommandCollectionRemoveMedia

Attributes supported for KMPXCommandIdCollectionRemoveMedia CMPXMedia , media to be removed (in param)

const TMPXAttributeData KMPXCommandCollectionRemoveMediaDeleteRecord

const TMPXAttributeData KMPXCommandCollectionRemoveMediaDeleteRecord

TBool, indicates whether to delete the records associated with the given media (in param)

const TMPXAttributeData KMPXCommandCollectionRemoveMediaError

const TMPXAttributeData KMPXCommandCollectionRemoveMediaError

TInt, error code (out param)

const TInt KMPXCommandIdCollectionCleanupDeletedMedias

const TInt KMPXCommandIdCollectionCleanupDeletedMedias

Content ID identifying sync. command to clean up medias that have been marked as deleted.

const TMPXAttributeData KMPXCommandCollectionCleanupError

const TMPXAttributeData KMPXCommandCollectionCleanupError

Attributes supported for KMPXCommandIdCollectionCleanupDeletedMedias

const TInt KMPXCommandIdCollectionPrepareDelete

const TInt KMPXCommandIdCollectionPrepareDelete

Remove all unused data before starting delete.

const TMPXAttributeData KMPXCommandCollectionPrepareRemovePath

const TMPXAttributeData KMPXCommandCollectionPrepareRemovePath

Attributes supported for KMPXCommandIdCollectionPrepareDelete CMPXCollectionPath , collection path (in/out param). The path to remove from the collection.

const TUint32 KMPXCommandIdCollectionCompleteDelete

const TUint32 KMPXCommandIdCollectionCompleteDelete

ContentID for completing the delete operation

const TMPXAttributeData KMPXCommandCollectionDeleteMsgArray

const TMPXAttributeData KMPXCommandCollectionDeleteMsgArray

const TMPXAttributeData KMPXCommandCollectionDeleteCompactDb

const TMPXAttributeData KMPXCommandCollectionDeleteCompactDb

const TUint32 KMPXCommandIdCollectionSelect

const TUint32 KMPXCommandIdCollectionSelect

Unique command ids for extensible commands

const TInt KMPXCommandContentIdCollection

const TInt KMPXCommandContentIdCollection

const TMPXAttributeData KMPXCommandCollectionSelectIndex

const TMPXAttributeData KMPXCommandCollectionSelectIndex

const TInt KMPXCommandIdCollectionAdd

const TInt KMPXCommandIdCollectionAdd

Unique command ids for add media to collection

const TMPXAttributeData KMPXCommandColAddMedia

const TMPXAttributeData KMPXCommandColAddMedia

const TMPXAttributeData KMPXCommandColAddRtnId

const TMPXAttributeData KMPXCommandColAddRtnId

const TInt KMPXCommandIdCollectionExecSql

const TInt KMPXCommandIdCollectionExecSql

Unique command ids for executing SQL statements to collection

const TMPXAttributeData KMPXCommandColSqlFile

const TMPXAttributeData KMPXCommandColSqlFile

const TInt KMPXCommandIdCollectionSet

const TInt KMPXCommandIdCollectionSet

Unique command ids for update media in collection

const TMPXAttributeData KMPXCommandColSetMedia

const TMPXAttributeData KMPXCommandColSetMedia

const TInt KMPXCommandIdReorderPlaylist

const TInt KMPXCommandIdReorderPlaylist

const TMPXAttributeData KMPXCommandReorderPlaylistId

const TMPXAttributeData KMPXCommandReorderPlaylistId

Attributes supported for KMPXCommandIdReorderPlaylist TMPXItemId , Id of the playlist to be reordered

const TMPXAttributeData KMPXCommandReorderSongId

const TMPXAttributeData KMPXCommandReorderSongId

TMPXItemId , Id of the song in the playlist to be reordered

const TMPXAttributeData KMPXCommandReorderOriginalOrdinal

const TMPXAttributeData KMPXCommandReorderOriginalOrdinal

TUint, original ordinal of the song in the playlist

const TMPXAttributeData KMPXCommandReorderNewOrdinal

const TMPXAttributeData KMPXCommandReorderNewOrdinal

TUint, new ordinal of the song in the playlist

const TInt KMPXCommandIdUpdateRefreshTime

const TInt KMPXCommandIdUpdateRefreshTime

const TInt KMPXCommandCollectionGetCount

const TInt KMPXCommandCollectionGetCount

const TMPXAttributeData KMPXCommandCollectionCountDrive

const TMPXAttributeData KMPXCommandCollectionCountDrive

Attributes supported for KMPXCommandCollectionGetCount TInt, drive number

const TMPXAttributeData KMPXCommandCollectionCountTable

const TMPXAttributeData KMPXCommandCollectionCountTable

TInt, what content should be retrieved: music, playlist or both, see EMPXCollectionCountEnum

const TMPXAttributeData KMPXCommandCollectionCountValue

const TMPXAttributeData KMPXCommandCollectionCountValue

TInt, collection count (out param).

const TInt KMPXCommandCollectionGetURIs

const TInt KMPXCommandCollectionGetURIs

const TMPXAttributeData KMPXCommandCollectionURIDrive

const TMPXAttributeData KMPXCommandCollectionURIDrive

Attributes supported for KMPXCommandCollectionGetURIs TInt, drive number

const TMPXAttributeData KMPXCommandCollectionURITable

const TMPXAttributeData KMPXCommandCollectionURITable

TInt, what content should be retrieved: music or playlist, see EMPXCollectionURIEnum

const TMPXAttributeData KMPXCommandCollectionURIRecords

const TMPXAttributeData KMPXCommandCollectionURIRecords

TInt, number of records to retrieve

const TMPXAttributeData KMPXCommandCollectionURIFromID

const TMPXAttributeData KMPXCommandCollectionURIFromID

TInt, ID of the record to use as a 'bottom' in SELECT

const TMPXAttributeData KMPXCommandCollectionURIList

const TMPXAttributeData KMPXCommandCollectionURIList

CDesCArray, an array of URIs associated with the given drive (out param)

const TMPXAttributeData KMPXCommandCollectionURILastID

const TMPXAttributeData KMPXCommandCollectionURILastID

TUint32, an ID of last retrieved URI for the array above (out param) assume that music table and playlist table are both indexed by unique ID note: Symbian does not recommend to use OFFSET and instead recommend item from index

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.