File: IUceService.aidl

package info (click to toggle)
android-platform-frameworks-base 1%3A10.0.0%2Br36-10
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 322,016 kB
  • sloc: java: 962,234; cpp: 274,298; xml: 242,770; python: 5,060; sh: 1,432; ansic: 494; makefile: 54; sed: 19
file content (211 lines) | stat: -rw-r--r-- 6,928 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
/*
 * Copyright (c) 2016 The Android Open Source Project
 *
 * 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.
 */

package com.android.ims.internal.uce.uceservice;

import com.android.ims.internal.uce.uceservice.IUceListener;
import com.android.ims.internal.uce.presence.IPresenceService;
import com.android.ims.internal.uce.options.IOptionsListener;
import com.android.ims.internal.uce.presence.IPresenceListener;
import com.android.ims.internal.uce.options.IOptionsService;
import com.android.ims.internal.uce.common.UceLong;
import com.android.ims.internal.uce.common.StatusCode;

/** IUceService
 *  UCE service interface class.
 * {@hide} */
interface IUceService
{

    /**
     * Starts the Uce service.
     * @param uceListener IUceListener object
     * @return boolean true if the service stop start is processed successfully, FALSE otherwise.
     *
     * Service status is returned in setStatus callback in IUceListener.
     * @hide
     */
    @UnsupportedAppUsage
    boolean startService(IUceListener uceListener);

    /**
     * Stops the UCE service.
     * @return boolean true if the service stop request is processed successfully, FALSE otherwise.
     * @hide
     */
    @UnsupportedAppUsage
    boolean stopService();



    /**
     * Requests the UCE service start status.
     * @return boolean true if service started else false.
     * @hide
     */
    @UnsupportedAppUsage
    boolean isServiceStarted();

    /**
     * Creates a options service for Capability Discovery.
     * @param optionsListener IOptionsListener object.
     * @param optionsServiceListenerHdl wrapper for client's listener handle to be stored.
     *
     * The service will fill UceLong.mUceLong with presenceListenerHandle allocated and
     * used to validate callbacks received in IPresenceListener are indeed from the
     * service the client created.
     *
     * @return  optionsServiceHandle
     *
     * @hide
     *
     * @deprecated This is replaced with new API createOptionsServiceForSubscription()
     */
    @UnsupportedAppUsage
    int createOptionsService(IOptionsListener optionsListener,
                             inout UceLong optionsServiceListenerHdl);
    /**
     * Creates a options service for Capability Discovery.
     * @param optionsListener IOptionsListener object.
     * @param optionsServiceListenerHdl wrapper for client's listener handle to be stored.
     * @param iccId the ICC-ID derived from SubscriptionInfo for the Service requested
     *
     * The service will fill UceLong.mUceLong with presenceListenerHandle allocated and
     * used to validate callbacks received in IPresenceListener are indeed from the
     * service the client created.
     *
     * @return  optionsServiceHandle
     *
     * @hide
     */
    int createOptionsServiceForSubscription(IOptionsListener optionsListener,
                             inout UceLong optionsServiceListenerHdl,
                             in String iccId);

    /**
     * Destroys a Options service.
     * @param optionsServiceHandle this is received in serviceCreated() callback
     *        in IOptionsListener
     * @hide
     */
    @UnsupportedAppUsage
    void destroyOptionsService(int optionsServiceHandle);

    /**
     * Creates a presence service.
     * @param presenceServiceListener IPresenceListener object
     * @param presenceServiceListenerHdl wrapper for client's listener handle to be stored.
     *
     * The service will fill UceLong.mUceLong with presenceListenerHandle allocated and
     * used to validate callbacks received in IPresenceListener are indeed from the
     * service the client created.
     *
     * @return  presenceServiceHdl
     *
     * @hide
     *
     * @deprecated This is replaced with new API createPresenceServiceForSubscription()
     */
    @UnsupportedAppUsage
    int createPresenceService(IPresenceListener presenceServiceListener,
                              inout UceLong presenceServiceListenerHdl);
    /**
     * Creates a presence service.
     * @param presenceServiceListener IPresenceListener object
     * @param presenceServiceListenerHdl wrapper for client's listener handle to be stored.
     * @param iccId the ICC-ID derived from SubscriptionInfo for the Service requested
     *
     * The service will fill UceLong.mUceLong with presenceListenerHandle allocated and
     * used to validate callbacks received in IPresenceListener are indeed from the
     * service the client created.
     *
     * @return  presenceServiceHdl
     *
     * @hide
     */
    int createPresenceServiceForSubscription(IPresenceListener presenceServiceListener,
                              inout UceLong presenceServiceListenerHdl,
                              in String iccId);

    /**
     * Destroys a presence service.
     *
     * @param presenceServiceHdl handle returned during createPresenceService()
     *
     * @hide
     */
    @UnsupportedAppUsage
    void destroyPresenceService(int presenceServiceHdl);



    /**
     * Query the UCE Service for information to know whether the is registered.
     *
     * @return boolean, true if Registered to for network events else false.
     *
     * @hide
     */
    @UnsupportedAppUsage
    boolean getServiceStatus();

    /**
     * Query the UCE Service for presence Service.
     *
     * @return IPresenceService object.
     *
     * @hide
     *
     * @deprecated use API getPresenceServiceForSubscription()
     */
    @UnsupportedAppUsage
    IPresenceService getPresenceService();

    /**
     * Query the UCE Service for presence Service.
     *
     * @param iccId the ICC-ID derived from SubscriptionInfo for the Service requested
     *
     * @return IPresenceService object.
     *
     * @hide
     */
    IPresenceService getPresenceServiceForSubscription(in String iccId);

    /**
     * Query the UCE Service for options service object.
     *
     * @return IOptionsService object.
     *
     * @deprecated use API getOptionsServiceForSubscription()
     *
     * @hide
     */
    @UnsupportedAppUsage
    IOptionsService getOptionsService();

    /**
     * Query the UCE Service for options service object.
     *
     * @param iccId the ICC-ID derived from SubscriptionInfo for the Service requested
     *
     * @return IOptionsService object.
     *
     * @hide
     */
    IOptionsService getOptionsServiceForSubscription(in String iccId);

}