#include <ups/upsclient.h>
class UserPromptService::RUpsManagement : public RScsClientBase |
Public Member Functions | |
---|---|
RUpsManagement() | |
IMPORT_C void | CancelAndCloseView() |
IMPORT_C void | CancelNotifyPolicyFilesChanged() |
IMPORT_C void | CancelUpdateDecision() |
IMPORT_C void | Close() |
IMPORT_C TInt | Connect() |
IMPORT_C void | CreateView(const CDecisionFilter &, TRequestStatus &) |
IMPORT_C void | DeleteDatabaseL() |
IMPORT_C void | DeleteDecisionsForExeL(const TSecureId &) |
IMPORT_C CDecisionRecord * | NextMatchL() |
IMPORT_C void | NotifyPluginsMayHaveChangedL() |
IMPORT_C void | NotifyPolicyFilesChanged(TRequestStatus &) |
IMPORT_C void | RemoveDecisionsL(const CDecisionFilter &) |
IMPORT_C void | UpdateDecision(TUint32, TBool, TRequestStatus &) |
Inherited Attributes | |
---|---|
RHandleBase::iHandle |
Inherited Enumerations | |
---|---|
RHandleBase:TAttributes | |
RSessionBase:TAttachMode |
This class supports the management API for the UPS.
IMPORT_C | RUpsManagement | ( | ) |
This constructor provides a single point of definition from which the superclass constructor is called.
IMPORT_C void | CancelAndCloseView | ( | ) |
Close down a view. This can also be used to cancel an outstanding CreateView request.
IMPORT_C void | CancelNotifyPolicyFilesChanged | ( | ) |
Cancel a previous call to NotifyPolicyFilesChanged.
Normally this functions should not be used, it is only present for testing the handling of abnormal events.
IMPORT_C void | CancelUpdateDecision | ( | ) |
Cancel an outstanding UpdateDecision request.
Normally this will not be used because an UpdateDecision call will complete very quickly, but internally the request is asynchronous and exposing the cancel API allows the cancel code path to be tested.
IMPORT_C void | Close | ( | ) |
Reimplemented from RScsClientBase::Close()
Cleanup and call RScsClientBase::Close
IMPORT_C TInt | Connect | ( | ) |
Connect to the UPS server.
Returns: Symbian OS error code where KErrNone indicates success and any other value indicates failure.
IMPORT_C void | CreateView | ( | const CDecisionFilter & | aFilter, |
TRequestStatus & | aStatus | |||
) |
Creates a view for records which match the supplied CDecisionFilter.
If the CDecisionFilter is created using the constructor which specifies all fields (or all fields are set), then an exact match will be searched for. If the CDecisionFilter is created without parameters, then any fields which are not set will match any record.
Only one view can be active in a single RUpsManagement session at any one time.
Simultaneous database updates, either from this management session, another session or the main UPS operation may cause the query to be aborted with KErrAbort.
When you are finished with the view you should call CancelAndCloseView (otherwise you will not be able to create a new view).
Parameter | Description |
---|---|
aFilter | Specifies the filter to be matched. |
IMPORT_C void | DeleteDatabaseL | ( | ) |
Deletes all stored UPS decisions.
IMPORT_C void | DeleteDecisionsForExeL | ( | const TSecureId & | aExeSid | ) |
The following three APIs are only for use by the UPS swi observer plugin and are discouraged for general use
Delete all decisions in the database for the specified executable.
Parameter | Description |
---|---|
aExeSid | The SID of the executable which has been deleted. |
IMPORT_C CDecisionRecord * | NextMatchL | ( | ) |
Returns the next matching record in the view created with CreateViewL.
Simultaneous database updates, either from this management session, another session or the main UPS operation may cause the query to be aborted with KErrAbort.
When you are finished with the view you should call CancelAndCloseView.
Returns: record ptr, or 0 if there are no more matching records. Leaves for other errors.
IMPORT_C void | NotifyPluginsMayHaveChangedL | ( | ) |
Notify the UPS that an ECOM plugin has been installed somewhere, which may be an evaluator. The UPS will reload all ECOM plugins ASAP.
IMPORT_C void | NotifyPolicyFilesChanged | ( | TRequestStatus & | aStatus | ) |
Policy files have been added, changed or deleted.
The UPS server will rebuild its policy file cache and delete decisions which relate to policy files which are no longer active (ie. have been deleted, or eclipsed by a policy file with a different major version number).
IMPORT_C void | RemoveDecisionsL | ( | const CDecisionFilter & | aFilter | ) |
Removes all records which match the supplied CDecisionFilter.
The filter can match/delete multiple records in one operation.
Parameter | Description |
---|---|
aFilter | Specifies the records to be deleted. |
IMPORT_C void | UpdateDecision | ( | TUint32 | aRecordId, |
TBool | aAllow, | |||
TRequestStatus & | aStatus | |||
) |
Updates the single record which matches the unique record ID.
This API ONLY updates the CDecisionRecord result field. The only legal values are ETrue (always) or EFalse (never)
Parameter | Description |
---|---|
aRecordId | Specifies the single record to update. |
aAllow | Allow or reject the request. |