class RApaLsSession : public RSessionBase |
A session with the application architecture server.
The server provides access to a cached list of the applications on the device.
To use this class, clients first need to connect to the server.
Then, one of GetAllApps(), GetEmbeddableApps() or GetFilteredApps() needs to be called. These functions do some initialisation of server data in preparation for returning the application list (which is owned by the server).
Then, GetNextApp() is called in a loop. The first time around, it populates the session's application list and retrieves the first application in the list. Further calls to GetNextApp() retrieve the remaining applications in the list, until RApaLsSession::ENoMoreAppsInList is returned.
The session should be closed when it is no longer needed, before it goes out of scope.
Various functions in RApaLsSession need to access the application list, and may return RApaLsSession::EAppListInvalid to indicate that the function was called before the initial population of the list is complete. If this occurs, you could try again after a short delay.
This class provides many other functions, for instance launching applications, querying application-specific information, recognising data.
Public Member Enumerations | |
---|---|
enum | TApaLsErrorCode { ENoMoreAppsInList = 1, EAppListInvalid } |
enum | TLaunchType { ELaunchNewApp = 1, ESwitchFiles } |
Inherited Enumerations | |
---|---|
RHandleBase:TAttributes | |
RSessionBase:TAttachMode |
Private Attributes | |
---|---|
CApaLsSessionExtension * | iExtension |
Inherited Attributes | |
---|---|
RHandleBase::iHandle |
IMPORT_C TInt | AppForDataType | ( | const TDataType & | aDataType, |
TUid & | aAppUid | |||
) | const |
IMPORT_C TInt | AppForDataTypeAndService | ( | const TDataType & | aDataType, |
TUid | aServiceUid, | |||
TUid & | aAppUid | |||
) | const |
IMPORT_C TInt | AppForDocument | ( | const TDesC & | aFileName, |
TUid & | aAppUid, | |||
TDataType & | aDataType | |||
) | const |
IMPORT_C TInt | AppForDocument | ( | const RFile & | aFile, |
TUid & | aAppUid, | |||
TDataType & | aDataType | |||
) | const |
IMPORT_C TInt | AppForDocumentAndService | ( | const TDesC & | aFileName, |
TUid | aServiceUid, | |||
TUid & | aAppUid, | |||
TDataType & | aDataType | |||
) | const |
IMPORT_C TInt | AppForDocumentAndService | ( | const RFile & | aFile, |
TUid | aServiceUid, | |||
TUid & | aAppUid, | |||
TDataType & | aDataType | |||
) | const |
IMPORT_C TInt | ApplicationLanguage | ( | TUid | aAppUid, |
TLanguage & | aLanguage | |||
) | const |
IMPORT_C TInt | CreateDocument | ( | const TDesC & | aDocFileName, |
TUid | aAppUid, | |||
TThreadId & | aThreadId, | |||
TLaunchType | aUnused = ELaunchNewApp | |||
) |
const TDesC & aDocFileName | |
TUid aAppUid | |
TThreadId & aThreadId | |
TLaunchType aUnused = ELaunchNewApp |
CBufFlat * | CreateRegFilesBufferL | ( | const RPointerArray< TDesC > & | aRegFiles | ) | [private, static] |
const RPointerArray< TDesC > & aRegFiles |
IMPORT_C TInt | DeleteDataMapping | ( | const TDataType & | aDataType | ) |
const TDataType & aDataType |
IMPORT_C TInt | DeleteDataMapping | ( | const TDataType & | aDataType, |
TUid | aServiceUid | |||
) |
void | DeletePointerToPointerToTAny | ( | TAny * | aPointerToPointerToTAny | ) | [private, static] |
TAny * aPointerToPointerToTAny |
IMPORT_C void | DeregisterNonNativeApplicationL | ( | TUid | aApplication | ) |
TUid aApplication |
IMPORT_C void | DeregisterNonNativeApplicationTypeL | ( | TUid | aApplicationType | ) |
TUid aApplicationType |
TInt | DoAppForDocumentOptionallySpecifyingService | ( | const TDesC & | aFileName, |
TUid | aServiceUid, | |||
TUid & | aAppUid, | |||
TDataType & | aDataType, | |||
TInt | aOpcode | |||
) | const [private] |
TInt | DoAppForDocumentOptionallySpecifyingService | ( | const RFile & | aFile, |
TUid | aServiceUid, | |||
TUid & | aAppUid, | |||
TDataType & | aDataType, | |||
TInt | aOpcode | |||
) | const [private] |
void | DoGetAppIconSizesL | ( | TUid | aAppUid, |
CArrayFixFlat< TSize > & | aArrayToFill | |||
) | const [private] |
TUid aAppUid | |
CArrayFixFlat< TSize > & aArrayToFill |
void | DoGetAppOwnedFilesL | ( | CDesCArray & | aArrayToFill, |
TUid | aAppUid | |||
) | const [private] |
CDesCArray & aArrayToFill | |
TUid aAppUid |
void | DoGetAppViewsL | ( | CApaAppViewArray & | aArrayToFill, |
TUid | aAppUid | |||
) | const [private] |
CApaAppViewArray & aArrayToFill | |
TUid aAppUid |
TInt | DoStartApp | ( | const CApaCommandLine & | aCommandLine, |
TThreadId * | aThreadId, | |||
TRequestStatus * | aRequestStatusForRendezvous | |||
) | [private] |
const CApaCommandLine & aCommandLine | |
TThreadId * aThreadId | |
TRequestStatus * aRequestStatusForRendezvous |
void | DoStartAppL | ( | const CApaCommandLine & | aCommandLine, |
TThreadId * | aThreadId, | |||
TRequestStatus * | aRequestStatusForRendezvous | |||
) | [private] |
const CApaCommandLine & aCommandLine | |
TThreadId * aThreadId | |
TRequestStatus * aRequestStatusForRendezvous |
void | DoStartApplicationL | ( | const TDesC & | aNativeExecutableName, |
const CApaCommandLine & | aCommandLine, | |||
TThreadId & | aThreadId, | |||
TRequestStatus * | aRequestStatusForRendezvous | |||
) | [private] |
const TDesC & aNativeExecutableName | |
const CApaCommandLine & aCommandLine | |
TThreadId & aThreadId | |
TRequestStatus * aRequestStatusForRendezvous |
IMPORT_C TInt | EmbeddableAppCount | ( | TInt & | aCount | ) | const |
TInt & aCount |
void | FetchArrayL | ( | MArrayFiller & | aArrayFiller, |
TUid | aAppUid, | |||
TInt | aOpcode, | |||
TInt | aInitialBufSize | |||
) | const [private] |
IMPORT_C TInt | ForceRegistration | ( | const RPointerArray< TDesC > & | aRegFiles | ) |
const RPointerArray< TDesC > & aRegFiles |
IMPORT_C TInt | GetAcceptedConfidence | ( | TInt & | aConfidence | ) | const |
TInt & aConfidence |
IMPORT_C TInt | GetAppByDataType | ( | const TDataType & | aDataType, |
TUid | aServiceUid, | |||
TUid & | aAppUid | |||
) | const |
IMPORT_C TInt | GetAppCapability | ( | TDes8 & | aCapabilityBuf, |
TUid | aAppUid | |||
) | const |
IMPORT_C TInt | GetAppIcon | ( | TUid | aAppUid, |
TInt | aSize, | |||
CApaMaskedBitmap & | aAppBitmap | |||
) | const |
TUid aAppUid | |
TInt aSize | |
CApaMaskedBitmap & aAppBitmap |
IMPORT_C TInt | GetAppIcon | ( | TUid | aAppUid, |
TSize | aSize, | |||
CApaMaskedBitmap & | aAppBitmap | |||
) | const |
TUid aAppUid | |
TSize aSize | |
CApaMaskedBitmap & aAppBitmap |
IMPORT_C TInt | GetAppIconSizes | ( | TUid | aAppUid, |
CArrayFixFlat< TSize > & | aArrayToFill | |||
) | const |
TUid aAppUid | |
CArrayFixFlat< TSize > & aArrayToFill |
IMPORT_C TInt | GetAppInfo | ( | TApaAppInfo & | aInfo, |
TUid | aAppUid | |||
) | const |
TApaAppInfo & aInfo | |
TUid aAppUid |
IMPORT_C TInt | GetAppOwnedFiles | ( | CDesCArray & | aAppOwnedFiles, |
TUid | aAppUid | |||
) | const |
CDesCArray & aAppOwnedFiles | |
TUid aAppUid |
IMPORT_C CApaAppServiceInfoArray * | GetAppServiceOpaqueDataLC | ( | TUid | aAppUid, |
TUid | aServiceUid | |||
) | const |
IMPORT_C void | GetAppServicesL | ( | TUid | aAppUid, |
CArrayFixFlat< TUid > & | aServiceUids | |||
) | const |
TUid aAppUid | |
CArrayFixFlat< TUid > & aServiceUids |
IMPORT_C CApaAppServiceInfoArray * | GetAppServicesLC | ( | TUid | aAppUid | ) | const |
TUid aAppUid |
IMPORT_C TInt | GetAppViewIcon | ( | TUid | aAppUid, |
TUid | aViewUid, | |||
const TSize & | aSize, | |||
CApaMaskedBitmap & | aViewBitmap | |||
) | const |
TUid aAppUid | |
TUid aViewUid | |
const TSize & aSize | |
CApaMaskedBitmap & aViewBitmap |
IMPORT_C TInt | GetAppViewIcon | ( | TUid | aAppUid, |
TUid | aViewUid, | |||
HBufC *& | aFullFileName | |||
) | const |
IMPORT_C TInt | GetAppViews | ( | CApaAppViewArray & | aAppViews, |
TUid | aAppUid | |||
) | const |
CApaAppViewArray & aAppViews | |
TUid aAppUid |
IMPORT_C TInt | GetDefaultScreenNumber | ( | TInt & | aDefaultScreenNumber, |
TUid | aAppUid | |||
) | const |
IMPORT_C TInt | GetEmbeddableApps | ( | TInt | aScreenMode | ) | const |
TInt aScreenMode |
TInt | GetExecutableNameAndNewOpaqueData | ( | TDes & | aNativeExecutableName, |
TDes & | aLogicalExecutableName, | |||
HBufC8 *& | aOpaqueData, | |||
TIpcArgs & | aIpcArgs, | |||
TInt | aOpcode | |||
) | const [private] |
IMPORT_C TInt | GetFilteredApps | ( | const TApaEmbeddabilityFilter & | aFilter | ) | const |
const TApaEmbeddabilityFilter & aFilter |
IMPORT_C TInt | GetFilteredApps | ( | const TApaEmbeddabilityFilter & | aFilter, |
TInt | aScreenMode | |||
) | const |
const TApaEmbeddabilityFilter & aFilter | |
TInt aScreenMode |
IMPORT_C TInt | GetFilteredApps | ( | TUint | aCapabilityAttributeMask, |
TUint | aCapabilityAttributeValue | |||
) | const |
IMPORT_C TInt | GetFilteredApps | ( | TUint | aCapabilityAttributeMask, |
TUint | aCapabilityAttributeValue, | |||
TInt | aScreenMode | |||
) | const |
void | GetMainThreadIdL | ( | TThreadId & | aThreadId, |
const RProcess & | aProcess | |||
) | [private, static] |
IMPORT_C TInt | GetMaxDataBufSize | ( | TInt & | aBufSize | ) | const |
TInt & aBufSize |
TInt | GetNewBufferFromFile | ( | HBufC8 *& | aBuffer, |
const TDesC & | aFileName | |||
) | const [private] |
TInt | GetNewOpaqueData | ( | HBufC8 *& | aOpaqueData, |
TInt | aLengthOfOpaqueData | |||
) | const [private] |
IMPORT_C TInt | GetNextApp | ( | TApaAppInfo & | aInfo | ) | const |
TApaAppInfo & aInfo |
IMPORT_C TInt | GetNextApp | ( | TApaAppInfo & | aInfo, |
TInt | aScreenMode | |||
) | const |
TApaAppInfo & aInfo | |
TInt aScreenMode |
IMPORT_C TInt | GetPreferredBufSize | ( | TInt & | aPreferredBufSize | ) | const |
TInt & aPreferredBufSize |
CBufBase * | GetServiceBufferLC | ( | TInt | aOpcode, |
TUid | aUid1, | |||
TUid | aUid2 = KNullUid | |||
) | const [private] |
CBufBase * | GetServiceBufferLC | ( | TInt | aOpcode, |
TUid | aUid1, | |||
const TDataType & | aDataType | |||
) | const [private] |
IMPORT_C CApaAppServiceInfoArray * | GetServiceImplementationsLC | ( | TUid | aServiceUid | ) | const |
TUid aServiceUid |
IMPORT_C CApaAppServiceInfoArray * | GetServiceImplementationsLC | ( | TUid | aServiceUid, |
const TDataType & | aDataType | |||
) | const |
IMPORT_C TInt | GetSupportedDataTypesL | ( | CDataTypeArray & | aDataTypes | ) | const |
CDataTypeArray & aDataTypes |
IMPORT_C TInt | InsertDataMapping | ( | const TDataType & | aDataType, |
TDataTypePriority | aPriority, | |||
TUid | aUid | |||
) |
const TDataType & aDataType | |
TDataTypePriority aPriority | |
TUid aUid |
IMPORT_C TInt | InsertDataMapping | ( | const TDataType & | aDataType, |
TDataTypePriority | aPriority, | |||
TUid | aUid, | |||
TUid | aServiceUid | |||
) |
const TDataType & aDataType | |
TDataTypePriority aPriority | |
TUid aUid | |
TUid aServiceUid |
IMPORT_C TInt | InsertDataMappingIfHigher | ( | const TDataType & | aDataType, |
TDataTypePriority | aPriority, | |||
TUid | aUid, | |||
TBool & | aInserted | |||
) |
const TDataType & aDataType | |
TDataTypePriority aPriority | |
TUid aUid | |
TBool & aInserted |
IMPORT_C TInt | IsProgram | ( | const TDesC & | aFileName, |
TBool & | aProgram | |||
) | const |
IMPORT_C TInt | MatchesSecurityPolicy | ( | TBool & | aMatches, |
TUid | aAppUid, | |||
const TSecurityPolicy & | aSecurityPolicy | |||
) | const |
TBool & aMatches | |
TUid aAppUid | |
const TSecurityPolicy & aSecurityPolicy |
IMPORT_C void | NotifyOnDataMappingChange | ( | TRequestStatus & | aRequestStatus | ) |
TRequestStatus & aRequestStatus |
IMPORT_C TInt | NumberOfOwnDefinedIcons | ( | TUid | aAppUid, |
TInt & | aCount | |||
) | const |
IMPORT_C TInt | RecognizeData | ( | const TDesC8 & | aBuffer, |
TDataRecognitionResult & | aDataType | |||
) | const |
const TDesC8 & aBuffer | |
TDataRecognitionResult & aDataType |
IMPORT_C TInt | RecognizeData | ( | const TDesC & | aName, |
const TDesC8 & | aBuffer, | |||
TDataRecognitionResult & | aDataType | |||
) | const |
const TDesC & aName | |
const TDesC8 & aBuffer | |
TDataRecognitionResult & aDataType |
IMPORT_C TInt | RecognizeData | ( | const RFile & | aFile, |
TDataRecognitionResult & | aDataType | |||
) | const |
const RFile & aFile | |
TDataRecognitionResult & aDataType |
IMPORT_C TInt | RecognizeFilesL | ( | const TDesC & | aPath, |
CDataRecognitionResultArray & | aResult | |||
) | const |
const TDesC & aPath | |
CDataRecognitionResultArray & aResult |
IMPORT_C void | RecognizeFilesL | ( | const TDesC & | aPath, |
CDataRecognitionResultArray & | aResult, | |||
TRequestStatus & | aStatus | |||
) |
const TDesC & aPath | |
CDataRecognitionResultArray & aResult | |
TRequestStatus & aStatus |
IMPORT_C TInt | RecognizeFilesL | ( | const TDesC & | aPath, |
const TDesC8 & | aDataType, | |||
CDataRecognitionResultArray & | aResult | |||
) | const |
const TDesC & aPath | |
const TDesC8 & aDataType | |
CDataRecognitionResultArray & aResult |
IMPORT_C void | RecognizeFilesL | ( | const TDesC & | aPath, |
const TDesC8 & | aDataType, | |||
CDataRecognitionResultArray & | aResult, | |||
TRequestStatus & | aStatus | |||
) |
const TDesC & aPath | |
const TDesC8 & aDataType | |
CDataRecognitionResultArray & aResult | |
TRequestStatus & aStatus |
IMPORT_C TInt | RecognizeSpecificData | ( | const TDesC & | aName, |
const TDesC8 & | aBuffer, | |||
const TDataType & | aDataType, | |||
TBool & | aResult | |||
) | const |
IMPORT_C TInt | RecognizeSpecificData | ( | const RFile & | aFile, |
const TDataType & | aDataType, | |||
TBool & | aResult | |||
) | const |
IMPORT_C void | RegisterListPopulationCompleteObserver | ( | TRequestStatus & | aStatus | ) | const |
TRequestStatus & aStatus |
IMPORT_C void | RegisterNonNativeApplicationL | ( | TUid | aApplicationType, |
const TDriveUnit & | aDrive, | |||
CApaRegistrationResourceFileWriter & | aRegistrationResourceFile, | |||
CApaLocalisableResourceFileWriter * | aLocalisableResourceFile, | |||
const RFile * | aIconFile | |||
) |
TUid aApplicationType | |
const TDriveUnit & aDrive | |
CApaRegistrationResourceFileWriter & aRegistrationResourceFile | |
CApaLocalisableResourceFileWriter * aLocalisableResourceFile | |
const RFile * aIconFile |
IMPORT_C void | RegisterNonNativeApplicationTypeL | ( | TUid | aApplicationType, |
const TDesC & | aNativeExecutable | |||
) |
TInt | SendReceiveWithReconnect | ( | TInt | aFunction, |
const TIpcArgs & | aIpcArgs | |||
) | const [private] |
IMPORT_C TInt | SetAcceptedConfidence | ( | TInt | aConfidence | ) |
TInt aConfidence |
IMPORT_C TInt | SetAppShortCaption | ( | const TDesC & | aShortCaption, |
TLanguage | aLanguage, | |||
TUid | aAppUid | |||
) |
IMPORT_C void | SetNotify | ( | TBool | aCompleteImmediatelyIfNoScanImpendingOrInProgress, |
TRequestStatus & | aStatus | |||
) |
TBool aCompleteImmediatelyIfNoScanImpendingOrInProgress | |
TRequestStatus & aStatus |
IMPORT_C TInt | StartApp | ( | const CApaCommandLine & | aCommandLine | ) |
const CApaCommandLine & aCommandLine |
IMPORT_C TInt | StartApp | ( | const CApaCommandLine & | aCommandLine, |
TThreadId & | aThreadId | |||
) |
const CApaCommandLine & aCommandLine | |
TThreadId & aThreadId |
IMPORT_C TInt | StartApp | ( | const CApaCommandLine & | aCommandLine, |
TThreadId & | aThreadId, | |||
TRequestStatus * | aRequestStatusForRendezvous | |||
) |
const CApaCommandLine & aCommandLine | |
TThreadId & aThreadId | |
TRequestStatus * aRequestStatusForRendezvous |
TInt | StartApplicationPassingDocumentName | ( | const TDesC & | aNativeExecutableName, |
const TDesC & | aLogicalExecutableName, | |||
const TDesC8 * | aOpaqueData, | |||
const TDesC & | aDocumentName, | |||
TThreadId & | aThreadId, | |||
TApaCommand | aCommand, | |||
TRequestStatus * | aRequestStatusForRendezvous | |||
) | [private] |
const TDesC & aNativeExecutableName | |
const TDesC & aLogicalExecutableName | |
const TDesC8 * aOpaqueData | |
const TDesC & aDocumentName | |
TThreadId & aThreadId | |
TApaCommand aCommand | |
TRequestStatus * aRequestStatusForRendezvous |
TInt | StartApplicationPassingFileHandle | ( | const TDesC & | aNativeExecutableName, |
const TDesC & | aLogicalExecutableName, | |||
const TDesC8 * | aOpaqueData, | |||
const RFile & | aFile, | |||
TThreadId & | aThreadId, | |||
TRequestStatus * | aRequestStatusForRendezvous | |||
) | [private] |
IMPORT_C TInt | StartDocument | ( | const TDesC & | aDocFileName, |
TThreadId & | aThreadId, | |||
TLaunchType | aUnused = ELaunchNewApp | |||
) |
const TDesC & aDocFileName | |
TThreadId & aThreadId | |
TLaunchType aUnused = ELaunchNewApp |
IMPORT_C TInt | StartDocument | ( | const TDesC & | aDocFileName, |
const TDataType & | aDataType, | |||
TThreadId & | aThreadId, | |||
TLaunchType | aUnused = ELaunchNewApp | |||
) |
const TDesC & aDocFileName | |
const TDataType & aDataType | |
TThreadId & aThreadId | |
TLaunchType aUnused = ELaunchNewApp |
IMPORT_C TInt | StartDocument | ( | const TDesC & | aDocFileName, |
TUid | aAppUid, | |||
TThreadId & | aThreadId, | |||
TLaunchType | aUnused = ELaunchNewApp | |||
) |
const TDesC & aDocFileName | |
TUid aAppUid | |
TThreadId & aThreadId | |
TLaunchType aUnused = ELaunchNewApp |
IMPORT_C TInt | StartDocument | ( | RFile & | aDocFile, |
TThreadId & | aThreadId, | |||
TRequestStatus * | aRequestStatusForRendezvous = NULL | |||
) |
RFile & aDocFile | |
TThreadId & aThreadId | |
TRequestStatus * aRequestStatusForRendezvous = NULL |
IMPORT_C TInt | StartDocument | ( | RFile & | aDocFile, |
const TDataType & | aDataType, | |||
TThreadId & | aThreadId, | |||
TRequestStatus * | aRequestStatusForRendezvous = NULL | |||
) |
RFile & aDocFile | |
const TDataType & aDataType | |
TThreadId & aThreadId | |
TRequestStatus * aRequestStatusForRendezvous = NULL |
IMPORT_C TInt | StartDocument | ( | RFile & | aDocFile, |
TUid | aAppUid, | |||
TThreadId & | aThreadId, | |||
TRequestStatus * | aRequestStatusForRendezvous = NULL | |||
) |
RFile & aDocFile | |
TUid aAppUid | |
TThreadId & aThreadId | |
TRequestStatus * aRequestStatusForRendezvous = NULL |
TInt | TransferAndInternalizeDataL | ( | const TDesC & | aPath, |
const TInt | aRequiredBufferSize, | |||
CDataRecognitionResultArray & | aResult | |||
) | const [private] |
const TDesC & aPath | |
const TInt aRequiredBufferSize | |
CDataRecognitionResultArray & aResult |
ENoMoreAppsInList = 1 |
A possible return value from GetNextApp(), to indicate that there are no more applications in the list. |
EAppListInvalid |
Indicates that an RApaLsSession member function was called before the session's application list is fully populated. |
Defines the way an application is launched. This is no longer in use. Has no effect!
ELaunchNewApp = 1 | |
ESwitchFiles |