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