interface_sdk-js/api/@ohos.app.ability.OpenLinkOptions.d.ts

54 lines
1.4 KiB
TypeScript
Raw Normal View History

/*
* 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
*/
/**
* Define the available options for openLink API.
*
* @interface OpenLinkOptions
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @stagemodelonly
* @atomicservice
* @since 12
*/
export default interface OpenLinkOptions {
/**
* Open the URL only if the URL is a valid app linking and
* there is an installed app capable of opening that URL.
*
* @type { ?boolean }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @stagemodelonly
* @atomicservice
* @since 12
*/
appLinkingOnly?: boolean;
/**
* OpenLinkOptions parameters in the form of custom key-value pairs.
*
* @type { ?Record<string, Object> }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @stagemodelonly
* @atomicservice
* @since 12
*/
parameters?: Record<string, Object>;
}