* Copyright (c) 2021-2025 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef OHOS_ABILITY_RUNTIME_ABILITY_SCHEDULE_PROXY_H
#define OHOS_ABILITY_RUNTIME_ABILITY_SCHEDULE_PROXY_H
#include "ability_scheduler_interface.h"
#include <iremote_proxy.h>
namespace OHOS {
namespace NativeRdb {
class AbsSharedResultSet;
class DataAbilityPredicates;
class ValuesBucket;
}
namespace AppExecFwk {
}
namespace AAFwk {
* @class AbilitySchedulerProxy
* AbilityScheduler proxy.
*/
class AbilitySchedulerProxy : public IRemoteProxy<IAbilityScheduler> {
public:
explicit AbilitySchedulerProxy(const sptr<IRemoteObject> &impl) : IRemoteProxy<IAbilityScheduler>(impl)
{}
virtual ~AbilitySchedulerProxy()
{}
* ScheduleAbilityTransaction, schedule ability to transform life state.
*
* @param Want, Special Want for service type's ability.
* @param stateInfo, The lifecycle state to be transformed.
*/
bool ScheduleAbilityTransaction(const Want &want, const LifeCycleStateInfo &stateInfo,
sptr<SessionInfo> sessionInfo = nullptr) override;
* ScheduleShareData, schedule ability to transform life state and share data with orgin ability.
*
* @param want, special Want for service type's ability.
* @param stateInfo, the lifecycle state to be transformed.
* @param uniqueId, the Id of origin ability request.
*/
void ScheduleShareData(const int32_t &uniqueId) override;
* SendResult, Send result to app when ability is terminated with result want.
*
* @param requestCode, the requestCode of the ability to start.
* @param resultCode, the resultCode of the ability to terminate.
* @param resultWant, the want of the ability to terminate.
*/
void SendResult(int requestCode, int resultCode, const Want &resultWant) override;
* ScheduleConnectAbility, schedule service ability to connect.
*
* @param Want, Special Want for service type's ability.
*/
void ScheduleConnectAbility(const Want &want) override;
* ScheduleDisconnectAbility, schedule service ability to disconnect.
*/
void ScheduleDisconnectAbility(const Want &want) override;
* ScheduleCommandAbility, schedule service ability to command.
*/
void ScheduleCommandAbility(const Want &want, bool restart, int startId) override;
void ScheduleCommandAbilityWindow(const Want &want, const sptr<SessionInfo> &sessionInfo,
WindowCommand winCmd) override;
* SchedulePrepareTerminateAbility, schedule service ability to prepare terminate.
*/
bool SchedulePrepareTerminateAbility() override;
* ScheduleSaveAbilityState, scheduling save ability state.
*/
void ScheduleSaveAbilityState() override;
* ScheduleRestoreAbilityState, scheduling restore ability state.
*/
void ScheduleRestoreAbilityState(const PacMap &inState) override;
* @brief Obtains the MIME types of files supported.
*
* @param uri Indicates the path of the files to obtain.
* @param mimeTypeFilter Indicates the MIME types of the files to obtain. This parameter cannot be null.
*
* @return Returns the matched MIME types. If there is no match, null is returned.
*/
virtual std::vector<std::string> GetFileTypes(const Uri &uri, const std::string &mimeTypeFilter) override;
* @brief Opens a file in a specified remote path.
*
* @param uri Indicates the path of the file to open.
* @param mode Indicates the file open mode, which can be "r" for read-only access, "w" for write-only access
* (erasing whatever data is currently in the file), "wt" for write access that truncates any existing file,
* "wa" for write-only access to append to any existing data, "rw" for read and write access on any existing data,
* or "rwt" for read and write access that truncates any existing file.
*
* @return Returns the file descriptor.
*/
virtual int OpenFile(const Uri &uri, const std::string &mode) override;
* @brief This is like openFile, open a file that need to be able to return sub-sections of files，often assets
* inside of their .hap.
*
* @param uri Indicates the path of the file to open.
* @param mode Indicates the file open mode, which can be "r" for read-only access, "w" for write-only access
* (erasing whatever data is currently in the file), "wt" for write access that truncates any existing file,
* "wa" for write-only access to append to any existing data, "rw" for read and write access on any existing
* data, or "rwt" for read and write access that truncates any existing file.
*
* @return Returns the RawFileDescriptor object containing file descriptor.
*/
virtual int OpenRawFile(const Uri &uri, const std::string &mode) override;
* @brief Inserts a single data record into the database.
*
* @param uri Indicates the path of the data to operate.
* @param value Indicates the data record to insert. If this parameter is null, a blank row will be inserted.
*
* @return Returns the index of the inserted data record.
*/
virtual int Insert(const Uri &uri, const NativeRdb::ValuesBucket &value) override;
* @brief Calls the method of the Data ability.
*
* @param uri Indicates the Data ability of the method to call.
* @param method Indicates the method to call.
* @param arg Indicates the parameter of the String type.
* @param pacMap Defines a PacMap object for storing a series of values.
*
* @return Returns the call result.
*/
virtual std::shared_ptr<AppExecFwk::PacMap> Call(
const Uri &uri, const std::string &method, const std::string &arg, const AppExecFwk::PacMap &pacMap) override;
* @brief Updates data records in the database.
*
* @param uri Indicates the path of data to update.
* @param value Indicates the data to update. This parameter can be null.
* @param predicates Indicates filter criteria. You should define the processing logic when this parameter is null.
*
* @return Returns the number of data records updated.
*/
virtual int Update(const Uri &uri, const NativeRdb::ValuesBucket &value,
const NativeRdb::DataAbilityPredicates &predicates) override;
* @brief Deletes one or more data records from the database.
*
* @param uri Indicates the path of the data to operate.
* @param predicates Indicates filter criteria. You should define the processing logic when this parameter is null.
*
* @return Returns the number of data records deleted.
*/
virtual int Delete(const Uri &uri, const NativeRdb::DataAbilityPredicates &predicates) override;
* @brief Deletes one or more data records from the database.
*
* @param uri Indicates the path of data to query.
* @param columns Indicates the columns to query. If this parameter is null, all columns are queried.
* @param predicates Indicates filter criteria. You should define the processing logic when this parameter is null.
*
* @return Returns the query result.
*/
virtual std::shared_ptr<NativeRdb::AbsSharedResultSet> Query(
const Uri &uri, std::vector<std::string> &columns, const NativeRdb::DataAbilityPredicates &predicates) override;
* @brief Obtains the MIME type matching the data specified by the URI of the Data ability. This method should be
* implemented by a Data ability. Data abilities supports general data types, including text, HTML, and JPEG.
*
* @param uri Indicates the URI of the data.
*
* @return Returns the MIME type that matches the data specified by uri.
*/
std::string GetType(const Uri &uri) override;
* @brief Reloads data in the database.
*
* @param uri Indicates the position where the data is to reload. This parameter is mandatory.
* @param extras Indicates the PacMap object containing the additional parameters to be passed in this call. This
* parameter can be null. If a custom Sequenceable object is put in the PacMap object and will be transferred across
* processes, you must call BasePacMap.setClassLoader(ClassLoader) to set a class loader for the custom object.
*
* @return Returns true if the data is successfully reloaded; returns false otherwise.
*/
bool Reload(const Uri &uri, const PacMap &extras) override;
* @brief Inserts multiple data records into the database.
*
* @param uri Indicates the path of the data to operate.
* @param values Indicates the data records to insert.
*
* @return Returns the number of data records inserted.
*/
int BatchInsert(const Uri &uri, const std::vector<NativeRdb::ValuesBucket> &values) override;
* @brief Registers an observer to DataObsMgr specified by the given Uri.
*
* @param uri, Indicates the path of the data to operate.
* @param dataObserver, Indicates the IDataAbilityObserver object.
*
* @return Return true if success. otherwise return false.
*/
bool ScheduleRegisterObserver(const Uri &uri, const sptr<IDataAbilityObserver> &dataObserver) override;
* @brief Deregisters an observer used for DataObsMgr specified by the given Uri.
*
* @param uri, Indicates the path of the data to operate.
* @param dataObserver, Indicates the IDataAbilityObserver object.
*
* @return Return true if success. otherwise return false.
*/
bool ScheduleUnregisterObserver(const Uri &uri, const sptr<IDataAbilityObserver> &dataObserver) override;
* @brief Notifies the registered observers of a change to the data resource specified by Uri.
*
* @param uri, Indicates the path of the data to operate.
*
* @return Return true if success. otherwise return false.
*/
bool ScheduleNotifyChange(const Uri &uri) override;
* @brief Converts the given uri that refer to the Data ability into a normalized URI. A normalized URI can be used
* across devices, persisted, backed up, and restored. It can refer to the same item in the Data ability even if the
* context has changed. If you implement URI normalization for a Data ability, you must also implement
* denormalizeUri(ohos.utils.net.Uri) to enable URI denormalization. After this feature is enabled, URIs passed to
* any method that is called on the Data ability must require normalization verification and denormalization. The
* default implementation of this method returns null, indicating that this Data ability does not support URI
* normalization.
*
* @param uri Indicates the Uri object to normalize.
*
* @return Returns the normalized Uri object if the Data ability supports URI normalization; returns null otherwise.
*/
Uri NormalizeUri(const Uri &uri) override;
* @brief Converts the given normalized uri generated by normalizeUri(ohos.utils.net.Uri) into a denormalized one.
* The default implementation of this method returns the original URI passed to it.
*
* @param uri uri Indicates the Uri object to denormalize.
*
* @return Returns the denormalized Uri object if the denormalization is successful; returns the original Uri passed
* to this method if there is nothing to do; returns null if the data identified by the original Uri cannot be found
* in the current environment.
*/
Uri DenormalizeUri(const Uri &uri) override;
* @brief Performs batch operations on the database.
*
* @param operations Indicates a list of database operations on the database.
* @return Returns the result of each operation, in array.
*/
std::vector<std::shared_ptr<AppExecFwk::DataAbilityResult>> ExecuteBatch(
const std::vector<std::shared_ptr<AppExecFwk::DataAbilityOperation>> &operations) override;
* ContinueAbility, call ContinueAbility() through proxy project,
* Notify continue ability.
*
* @param deviceId Target deviceId.
* @param versionCode Target bundle version.
* @return
*/
void ContinueAbility(const std::string& deviceId, uint32_t versionCode) override;
* NotifyContinuationResult, call NotifyContinuationResult() through proxy project,
* Notify continuation result to ability.
*
* @param The continuation result.
* @return
*/
void NotifyContinuationResult(int32_t result) override;
* Dump Ability Runner info.
*
* @param
* @return Ability Runner info.
*/
void DumpAbilityInfo(const std::vector<std::string> ¶ms, std::vector<std::string> &info) override;
void CallRequest() override;
int32_t CreateModalUIExtension(const Want &want) override;
void OnExecuteIntent(const Want &want) override;
void ExecuteSkill(const Want &want) override;
* @brief Update sessionToken.
* @param sessionToken The token of session.
*/
void UpdateSessionToken(sptr<IRemoteObject> sessionToken) override;
void ScheduleCollaborate(const Want &want) override;
void ScheduleAbilityRequestFailure(const std::string &requestId, const AppExecFwk::ElementName &element,
const std::string &message, int32_t resultCode = 0) override;
void ScheduleAbilityRequestSuccess(const std::string &requestId, const AppExecFwk::ElementName &element) override;
void ScheduleAbilitiesRequestDone(const std::string &requestKey, int32_t resultCode) override;
private:
bool WriteInterfaceToken(MessageParcel &data);
int32_t SendTransactCmd(uint32_t code, MessageParcel &data, MessageParcel &reply, MessageOption &option);
private:
static inline BrokerDelegator<AbilitySchedulerProxy> delegator_;
};
}
}
#endif