PresenceMapping.java
上传用户: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.imps;
  18. import java.util.Map;
  19. public interface PresenceMapping {
  20.     /**
  21.      * Tells if the mapping needs all presence values sent in protocol. If this
  22.      * method returns true, the framework will pass all the presence values
  23.      * received from the server when map to the predefined status.
  24.      *
  25.      * @return true if needs; false otherwise.
  26.      */
  27.     boolean requireAllPresenceValues();
  28.     /**
  29.      * Map the presence values sent in protocol to the predefined presence
  30.      * status.
  31.      *
  32.      * @param onlineStatus The value of presence <OnlineStatus> received
  33.      *            from the server.
  34.      * @param userAvailability The value of presence <UserAvailibility>
  35.      *            received from the server.
  36.      * @param allValues The whole presence values received from the server.
  37.      * @return a predefined status.
  38.      * @see #requireAllPresenceValues()
  39.      */
  40.     int getPresenceStatus(boolean onlineStatus, String userAvailability,
  41.              Map<String, Object> allValues);
  42.     /**
  43.      * Gets the value of &lt;OnlineStatus&gt; will be sent to the server when
  44.      * update presence to the predefined status.
  45.      *
  46.      * @param status the predefined status.
  47.      * @return The value of &lt;OnlineStatus&gt; will be sent to the server
  48.      */
  49.     boolean getOnlineStatus(int status);
  50.     /**
  51.      * Gets the value of &lt;UserAvaibility&gt; will be sent to the server when
  52.      * update presence to the predefined status.
  53.      *
  54.      * @param status the predefined status.
  55.      * @return The value of &lt;UserAvaibility&gt; will be sent to the server
  56.      */
  57.     String getUserAvaibility(int status);
  58.     /**
  59.      * Gets the extra presence values other than &lt;OnlineStatus&gt; and
  60.      * &lt;UserAvaibility&gt; will be sent to the server when update presence to
  61.      * the predefined status.
  62.      *
  63.      * @param status the predefined status.
  64.      * @return The extra values that will be sent to the server.
  65.      */
  66.     Map<String, Object> getExtra(int status);
  67.     /**
  68.      * Gets an array of the supported presence status. The client can only update
  69.      * presence to the values in the array.
  70.      *
  71.      * @return an array of the supported presence status.
  72.      */
  73.     int[] getSupportedPresenceStatus();
  74. }