• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2021 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  * Want is the basic communication component of the system.
18  * @name Want
19  * @since 6
20  * @syscap SystemCapability.Ability.AbilityBase
21  * @permission N/A
22  */
23export declare interface Want {
24  /**
25   * device id
26   * @default -
27   * @since 6
28   * @syscap SystemCapability.Ability.AbilityBase
29   */
30  deviceId?: string;
31
32  /**
33   * bundle name
34   * @default -
35   * @since 6
36   * @syscap SystemCapability.Ability.AbilityBase
37   */
38  bundleName?: string;
39
40  /**
41   * ability name
42   * @default -
43   * @since 6
44   * @syscap SystemCapability.Ability.AbilityBase
45   */
46  abilityName?: string;
47
48  /**
49   * The description of a URI in a Want.
50   * @since 6
51   * @syscap SystemCapability.Ability.AbilityBase
52   * @default -
53   */
54  uri?: string;
55
56  /**
57   * The description of the type in this Want.
58   * @since 6
59   * @syscap SystemCapability.Ability.AbilityBase
60   * @default -
61   */
62  type?: string;
63
64  /**
65   * The options of the flags in this Want.
66   * @since 6
67   * @syscap SystemCapability.Ability.AbilityBase
68   * @default -
69   */
70  flags?: number;
71
72  /**
73   * The description of an action in an want.
74   * @since 6
75   * @syscap SystemCapability.Ability.AbilityBase
76   * @default -
77   */
78  action?: string;
79
80  /**
81   * The description of the WantParams object in an Want
82   * @since 6
83   * @syscap SystemCapability.Ability.AbilityBase
84   * @default -
85   */
86  parameters?: {[key: string]: any};
87
88  /**
89   * The description of a entities in a Want.
90   * @since 6
91   * @syscap SystemCapability.Ability.AbilityBase
92   * @default -
93   */
94  entities?: Array<string>;
95}