Symbian^3 Product Developer Library >

mpxcollectioncommanddefs.h File Reference

const TInt KMPXCommandIdCollectionRetrieveUriForDeletion

const TIntKMPXCommandIdCollectionRetrieveUriForDeletion

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 TMPXAttributeDataKMPXCommandCollectionRetrievePath

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 TMPXAttributeDataKMPXCommandCollectionRetrieveUriError

TInt, error code (out param)

const TMPXAttributeData KMPXCommandCollectionRetrieveMediaUriArray

const TMPXAttributeDataKMPXCommandCollectionRetrieveMediaUriArray

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

const TInt KMPXCommandIdCollectionRemove

const TIntKMPXCommandIdCollectionRemove

Content ID identifying incremental sync. Remove command

const TMPXAttributeData KMPXCommandCollectionRemovePath

const TMPXAttributeDataKMPXCommandCollectionRemovePath

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 TMPXAttributeDataKMPXCommandCollectionRemoveMediaCount

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 TMPXAttributeDataKMPXCommandCollectionRemoveError

TInt, error code (out param)

const TMPXAttributeData KMPXCommandCollectionRemoveCompleted

const TMPXAttributeDataKMPXCommandCollectionRemoveCompleted

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

const TMPXAttributeData KMPXCommandCollectionRemoveSuppressMsgs

const TMPXAttributeDataKMPXCommandCollectionRemoveSuppressMsgs

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

const TMPXAttributeData KMPXCommandCollectionChangeMsgs

const TMPXAttributeDataKMPXCommandCollectionChangeMsgs

CMPXMessageArray to store collection messages

const TInt KMPXCommandIdCollectionRemoveMedia

const TIntKMPXCommandIdCollectionRemoveMedia

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 TMPXAttributeDataKMPXCommandCollectionRemoveMedia

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

const TMPXAttributeData KMPXCommandCollectionRemoveMediaDeleteRecord

const TMPXAttributeDataKMPXCommandCollectionRemoveMediaDeleteRecord

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

const TMPXAttributeData KMPXCommandCollectionRemoveMediaError

const TMPXAttributeDataKMPXCommandCollectionRemoveMediaError

TInt, error code (out param)

const TInt KMPXCommandIdCollectionCleanupDeletedMedias

const TIntKMPXCommandIdCollectionCleanupDeletedMedias

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

const TMPXAttributeData KMPXCommandCollectionCleanupError

const TMPXAttributeDataKMPXCommandCollectionCleanupError

Attributes supported for KMPXCommandIdCollectionCleanupDeletedMedias

const TInt KMPXCommandIdCollectionPrepareDelete

const TIntKMPXCommandIdCollectionPrepareDelete

Remove all unused data before starting delete.

const TMPXAttributeData KMPXCommandCollectionPrepareRemovePath

const TMPXAttributeDataKMPXCommandCollectionPrepareRemovePath

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

const TUint32 KMPXCommandIdCollectionCompleteDelete

const TUint32KMPXCommandIdCollectionCompleteDelete

ContentID for completing the delete operation

const TMPXAttributeData KMPXCommandCollectionDeleteMsgArray

const TMPXAttributeDataKMPXCommandCollectionDeleteMsgArray

const TMPXAttributeData KMPXCommandCollectionDeleteCompactDb

const TMPXAttributeDataKMPXCommandCollectionDeleteCompactDb

const TUint32 KMPXCommandIdCollectionSelect

const TUint32KMPXCommandIdCollectionSelect

Unique command ids for extensible commands

const TInt KMPXCommandContentIdCollection

const TIntKMPXCommandContentIdCollection

const TMPXAttributeData KMPXCommandCollectionSelectIndex

const TMPXAttributeDataKMPXCommandCollectionSelectIndex

const TInt KMPXCommandIdCollectionAdd

const TIntKMPXCommandIdCollectionAdd

Unique command ids for add media to collection

const TMPXAttributeData KMPXCommandColAddMedia

const TMPXAttributeDataKMPXCommandColAddMedia

const TMPXAttributeData KMPXCommandColAddRtnId

const TMPXAttributeDataKMPXCommandColAddRtnId

const TInt KMPXCommandIdCollectionExecSql

const TIntKMPXCommandIdCollectionExecSql

Unique command ids for executing SQL statements to collection

const TMPXAttributeData KMPXCommandColSqlFile

const TMPXAttributeDataKMPXCommandColSqlFile

const TInt KMPXCommandIdCollectionSet

const TIntKMPXCommandIdCollectionSet

Unique command ids for update media in collection

const TMPXAttributeData KMPXCommandColSetMedia

const TMPXAttributeDataKMPXCommandColSetMedia

const TInt KMPXCommandIdReorderPlaylist

const TIntKMPXCommandIdReorderPlaylist

const TMPXAttributeData KMPXCommandReorderPlaylistId

const TMPXAttributeDataKMPXCommandReorderPlaylistId

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

const TMPXAttributeData KMPXCommandReorderSongId

const TMPXAttributeDataKMPXCommandReorderSongId

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

const TMPXAttributeData KMPXCommandReorderOriginalOrdinal

const TMPXAttributeDataKMPXCommandReorderOriginalOrdinal

TUint, original ordinal of the song in the playlist

const TMPXAttributeData KMPXCommandReorderNewOrdinal

const TMPXAttributeDataKMPXCommandReorderNewOrdinal

TUint, new ordinal of the song in the playlist

const TInt KMPXCommandIdUpdateRefreshTime

const TIntKMPXCommandIdUpdateRefreshTime

const TInt KMPXCommandCollectionGetCount

const TIntKMPXCommandCollectionGetCount

const TMPXAttributeData KMPXCommandCollectionCountDrive

const TMPXAttributeDataKMPXCommandCollectionCountDrive

Attributes supported for KMPXCommandCollectionGetCount TInt, drive number

const TMPXAttributeData KMPXCommandCollectionCountTable

const TMPXAttributeDataKMPXCommandCollectionCountTable

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

const TMPXAttributeData KMPXCommandCollectionCountValue

const TMPXAttributeDataKMPXCommandCollectionCountValue

TInt, collection count (out param).

const TInt KMPXCommandCollectionGetURIs

const TIntKMPXCommandCollectionGetURIs

const TMPXAttributeData KMPXCommandCollectionURIDrive

const TMPXAttributeDataKMPXCommandCollectionURIDrive

Attributes supported for KMPXCommandCollectionGetURIs TInt, drive number

const TMPXAttributeData KMPXCommandCollectionURITable

const TMPXAttributeDataKMPXCommandCollectionURITable

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

const TMPXAttributeData KMPXCommandCollectionURIRecords

const TMPXAttributeDataKMPXCommandCollectionURIRecords

TInt, number of records to retrieve

const TMPXAttributeData KMPXCommandCollectionURIFromID

const TMPXAttributeDataKMPXCommandCollectionURIFromID

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

const TMPXAttributeData KMPXCommandCollectionURIList

const TMPXAttributeDataKMPXCommandCollectionURIList

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

const TMPXAttributeData KMPXCommandCollectionURILastID

const TMPXAttributeDataKMPXCommandCollectionURILastID

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.