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
|
/*
* 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
*/
boolean startService(IUceListener uceListener);
/**
* Stops the UCE service.
* @return boolean true if the service stop request is processed successfully, FALSE otherwise.
* @hide
*/
boolean stopService();
/**
* Requests the UCE service start status.
* @return boolean true if service started else false.
* @hide
*/
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
*/
int createOptionsService(IOptionsListener optionsListener,
inout UceLong optionsServiceListenerHdl);
/**
* Destroys a Options service.
* @param optionsServiceHandle this is received in serviceCreated() callback
* in IOptionsListener
* @hide
*/
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
*/
int createPresenceService(IPresenceListener presenceServiceListener,
inout UceLong presenceServiceListenerHdl);
/**
* Destroys a presence service.
* @param presenceServiceHdl handle returned during createPresenceService()
* @hide
*/
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
*/
boolean getServiceStatus();
/**
* Query the UCE Service for presence Service.
* @return IPresenceService object.
* @hide
*/
IPresenceService getPresenceService();
/**
* Query the UCE Service for options service object.
* @return IOptionsService object.
* @hide
*/
IOptionsService getOptionsService();
}
|