IPresenceMapping.aidl
上传用户:szyujian
上传日期:2016-09-20
资源大小:320k
文件大小:3k
源码类别:

android开发

开发平台:

C/C++

  1. /*
  2.  * Copyright (C) 2008 Esmertec AG.
  3.  * Copyright (C) 2008 The Android Open Source Project
  4.  *
  5.  * Licensed under the Apache License, Version 2.0 (the "License");
  6.  * you may not use this file except in compliance with the License.
  7.  * You may obtain a copy of the License at
  8.  *
  9.  *      http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  17. package com.android.im.plugin;
  18. /**
  19.  * The methods used to map presence value sent in protocol to predefined
  20.  * presence status.
  21.  */
  22. interface IPresenceMapping {
  23.     /**
  24.      * Tells if the mapping needs all presence values sent in protocol. If this
  25.      * method returns true, the framework will pass all the presence values
  26.      * received from the server when map to the predefined status.
  27.      *
  28.      * @return true if needs; false otherwise.
  29.      */
  30.     boolean requireAllPresenceValues();
  31.     /**
  32.      * Map the presence values sent in protocol to the predefined presence
  33.      * status.
  34.      *
  35.      * @param onlineStatus The value of presence <OnlineStatus> received
  36.      *            from the server.
  37.      * @param userAvailability The value of presence <UserAvailibility>
  38.      *            received from the server.
  39.      * @param allValues The whole presence values received from the server.
  40.      * @return a predefined status.
  41.      * @see #requireAllPresenceValues()
  42.      */
  43.     int getPresenceStatus(boolean onlineStatus, String userAvailability,
  44.             in Map allValues);
  45.     /**
  46.      * Gets the value of <OnlineStatus> will be sent to the server when
  47.      * update presence to the predefined status.
  48.      *
  49.      * @param status the predefined status.
  50.      * @return The value of <OnlineStatus> will be sent to the server
  51.      */
  52.     boolean getOnlineStatus(int status);
  53.     /**
  54.      * Gets the value of <UserAvaibility> will be sent to the server when
  55.      * update presence to the predefined status.
  56.      *
  57.      * @param status the predefined status.
  58.      * @return The value of <UserAvaibility> will be sent to the server
  59.      */
  60.     String getUserAvaibility(int status);
  61.     /**
  62.      * Gets the extra presence values other than <OnlineStatus> and
  63.      * <UserAvaibility> will be sent to the server when update presence to
  64.      * the predefined status.
  65.      *
  66.      * @param status the predefined status.
  67.      * @return The extra values that will be sent to the server.
  68.      */
  69.     Map getExtra(int status);
  70.     /**
  71.      * Gets an array of the supported presence status. The client can only update
  72.      * presence to the values in the array.
  73.      *
  74.      * @return an array of the supported presence status.
  75.      */
  76.     int[] getSupportedPresenceStatus();
  77. }