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