mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-11-23 07:10:52 +00:00
Context support sendable.
Sig:SIG_ApplicationFramework Feature or BugFix: Feature Binary Source: No Signed-off-by: zhangyafei.echo <zhangyafei12@huawei.com> Change-Id: I721e9629d570f6c530abf53c0cbcc86eb33e7c0d
This commit is contained in:
parent
8325c295d4
commit
e37989de47
117
api/@ohos.app.ability.sendableContextManager.d.ets
Normal file
117
api/@ohos.app.ability.sendableContextManager.d.ets
Normal file
@ -0,0 +1,117 @@
|
||||
/*
|
||||
* Copyright (C) 2024 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.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit AbilityKit
|
||||
*/
|
||||
|
||||
import common from '@ohos.app.ability.common';
|
||||
import type { SendableContext as _SendableContext } from './application/SendableContext';
|
||||
|
||||
/**
|
||||
* Sendable context manager.
|
||||
*
|
||||
* @namespace sendableContextManager
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @stagemodelonly
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
declare namespace sendableContextManager {
|
||||
/**
|
||||
* The class of sendable context object.
|
||||
*
|
||||
* @typedef { _SendableContext }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @stagemodelonly
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
export type SendableContext = _SendableContext;
|
||||
|
||||
/**
|
||||
* Convert the context to a sendable context object.
|
||||
* Support Context, ApplicationContext, AbilityStageContext and UIAbilityContext.
|
||||
*
|
||||
* @param { context } common.Context - The Context.
|
||||
* @returns { SendableContext } The sendable context object.
|
||||
* @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types;
|
||||
* 2.Parameter verification failed.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @stagemodelonly
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
function convertFromContext(context: common.Context): SendableContext;
|
||||
|
||||
/**
|
||||
* Convert a sendable context to a Context.
|
||||
*
|
||||
* @param { sendableContext } SendableContext - The sendable context.
|
||||
* @returns { common.Context } The Context.
|
||||
* @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types;
|
||||
* 2.Parameter verification failed.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @stagemodelonly
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
function convertToContext(sendableContext: SendableContext): common.Context;
|
||||
|
||||
/**
|
||||
* Convert a sendable context to a ApplicationContext.
|
||||
*
|
||||
* @param { sendableContext } SendableContext - The sendable context.
|
||||
* @returns { common.ApplicationContext } The ApplicationContext.
|
||||
* @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types;
|
||||
* 2.Parameter verification failed.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @stagemodelonly
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
function convertToApplicationContext(sendableContext: SendableContext): common.ApplicationContext;
|
||||
|
||||
/**
|
||||
* Convert a sendable context to a AbilityStageContext.
|
||||
*
|
||||
* @param { sendableContext } SendableContext - The sendable context.
|
||||
* @returns { common.AbilityStageContext } The AbilityStageContext.
|
||||
* @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types;
|
||||
* 2.Parameter verification failed.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @stagemodelonly
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
function convertToAbilityStageContext(sendableContext: SendableContext): common.AbilityStageContext;
|
||||
|
||||
/**
|
||||
* Convert a sendable context to a UIAbilityContext.
|
||||
*
|
||||
* @param { sendableContext } SendableContext - The sendable context.
|
||||
* @returns { common.UIAbilityContext } The UIAbilityContext.
|
||||
* @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types;
|
||||
* 2.Parameter verification failed.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @stagemodelonly
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
function convertToUIAbilityContext(sendableContext: SendableContext): common.UIAbilityContext;
|
||||
}
|
||||
|
||||
export default sendableContextManager;
|
36
api/application/SendableContext.d.ets
Normal file
36
api/application/SendableContext.d.ets
Normal file
@ -0,0 +1,36 @@
|
||||
/*
|
||||
* Copyright (C) 2024 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.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit AbilityKit
|
||||
*/
|
||||
|
||||
import lang from '../arkts/@arkts.lang';
|
||||
|
||||
/**
|
||||
* The sendable context. SendableContext is sendable data that supports the sendable protocol.
|
||||
* It's used to convert a Context object to SendableContext object for inter-thread transfer and
|
||||
* convert a SendableContext object into a Context object for in-thread use.
|
||||
*
|
||||
* @typedef SendableContext
|
||||
* @extends lang.ISendable
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @stagemodelonly
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
interface SendableContext extends lang.ISendable {
|
||||
}
|
4
kits/@kit.AbilityKit.d.ts
vendored
4
kits/@kit.AbilityKit.d.ts
vendored
@ -96,6 +96,7 @@ import StartupConfigEntry from '@ohos.app.appstartup.StartupConfigEntry';
|
||||
import StartupListener from '@ohos.app.appstartup.StartupListener';
|
||||
import StartupTask from '@ohos.app.appstartup.StartupTask';
|
||||
import startupManager from '@ohos.app.appstartup.startupManager';
|
||||
import sendableContextManager from '@ohos.app.ability.sendableContextManager';
|
||||
import screenLockFileManager from "@ohos.ability.screenLockFileManager";
|
||||
import AtomicServiceOptions from "@ohos.app.ability.AtomicServiceOptions";
|
||||
import EmbeddableUIAbility from '@ohos.app.ability.EmbeddableUIAbility';
|
||||
@ -115,5 +116,6 @@ export {
|
||||
innerBundleManager, insightIntent, insightIntentDriver, installer, launcherBundleManager, missionManager,
|
||||
overlay, particleAbility, quickFixManager, uriPermissionManager, wantAgent, wantConstant, privacyManager,
|
||||
EmbeddedUIExtensionAbility, StartupConfig, StartupConfigEntry, StartupListener, StartupTask, startupManager,
|
||||
screenLockFileManager, AtomicServiceOptions, EmbeddableUIAbility, ChildProcessArgs, ChildProcessOptions
|
||||
screenLockFileManager, AtomicServiceOptions, EmbeddableUIAbility, ChildProcessArgs, ChildProcessOptions,
|
||||
sendableContextManager
|
||||
};
|
||||
|
Loading…
Reference in New Issue
Block a user