FileDocCategorySizeDatePackage
PresenceMapping.javaAPI DocAndroid 1.5 API2939Wed May 06 22:42:46 BST 2009com.android.im.imps

PresenceMapping

public interface PresenceMapping

Fields Summary
Constructors Summary
Methods Summary
public java.util.MapgetExtra(int status)
Gets the extra presence values other than <OnlineStatus> and <UserAvaibility> will be sent to the server when update presence to the predefined status.

param
status the predefined status.
return
The extra values that will be sent to the server.

public booleangetOnlineStatus(int status)
Gets the value of <OnlineStatus> will be sent to the server when update presence to the predefined status.

param
status the predefined status.
return
The value of <OnlineStatus> will be sent to the server

public intgetPresenceStatus(boolean onlineStatus, java.lang.String userAvailability, java.util.Map allValues)
Map the presence values sent in protocol to the predefined presence status.

param
onlineStatus The value of presence <OnlineStatus> received from the server.
param
userAvailability The value of presence <UserAvailibility> received from the server.
param
allValues The whole presence values received from the server.
return
a predefined status.
see
#requireAllPresenceValues()

public int[]getSupportedPresenceStatus()
Gets an array of the supported presence status. The client can only update presence to the values in the array.

return
an array of the supported presence status.

public java.lang.StringgetUserAvaibility(int status)
Gets the value of <UserAvaibility> will be sent to the server when update presence to the predefined status.

param
status the predefined status.
return
The value of <UserAvaibility> will be sent to the server

public booleanrequireAllPresenceValues()
Tells if the mapping needs all presence values sent in protocol. If this method returns true, the framework will pass all the presence values received from the server when map to the predefined status.

return
true if needs; false otherwise.