• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2024 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16/**
17 * @file
18 * @kit AbilityKit
19 */
20
21/**
22 * Define the available options for openLink API.
23 *
24 * @interface OpenLinkOptions
25 * @syscap SystemCapability.Ability.AbilityRuntime.Core
26 * @stagemodelonly
27 * @atomicservice
28 * @since arkts {'1.1':'12', '1.2':'20'}
29 * @arkts 1.1&1.2
30 */
31export default interface OpenLinkOptions {
32  /**
33   * Open the URL only if the URL is a valid app linking and
34   * there is an installed app capable of opening that URL.
35   *
36   * @type { ?boolean }
37   * @syscap SystemCapability.Ability.AbilityRuntime.Core
38   * @stagemodelonly
39   * @atomicservice
40   * @since arkts {'1.1':'12', '1.2':'20'}
41   * @arkts 1.1&1.2
42   */
43  appLinkingOnly?: boolean;
44
45  /**
46   * OpenLinkOptions parameters in the form of custom key-value pairs.
47   *
48   * @type { ?Record<string, Object> }
49   * @syscap SystemCapability.Ability.AbilityRuntime.Core
50   * @stagemodelonly
51   * @atomicservice
52   * @since arkts {'1.1':'12', '1.2':'20'}
53   * @arkts 1.1&1.2
54   */
55  parameters?: Record<string, Object>;
56}
57