org.elastos.carrier

Interface CarrierHandler

All Superinterfaces:

GroupHandler

All Known Implementing Classes:

AbstractCarrierHandler

public interface CarrierHandler
extends GroupHandler

The interface to Carrier node.

Method Summary

Modifier and Type	Method and Description
void	onConnection(Carrier carrier, ConnectionStatus status) The callback function to process the self connection status.
void	onFriendAdded(Carrier carrier, FriendInfo friendInfo) The callback function to process the new friend added event.
void	onFriendConnection(Carrier carrier, java.lang.String friendId, ConnectionStatus status) The callback function to process the friend connections status changed event.
void	onFriendInfoChanged(Carrier carrier, java.lang.String friendId, FriendInfo info) The callback function to process the friend information changed event.
void	onFriendInviteRequest(Carrier carrier, java.lang.String from, java.lang.String data) The callback function to process the friend invite request.
void	onFriendMessage(Carrier carrier, java.lang.String from, byte[] message, java.util.Date timestamp, boolean isOffline) The callback function to process the friend message.
void	onFriendPresence(Carrier carrier, java.lang.String friendId, PresenceStatus presence) The callback function to process the friend presence changed event.
void	onFriendRemoved(Carrier carrier, java.lang.String friendId) The callback function to process the friend removed event.
void	onFriendRequest(Carrier carrier, java.lang.String userId, UserInfo info, java.lang.String hello) The callback function to process the friend request.
void	onFriends(Carrier carrier, java.util.List<FriendInfo> friends) The callback function to iterate the each friend item in friend list.
void	onGroupInvite(Carrier carrier, java.lang.String from, byte[] cookie) The callback function to process the group invite request.
void	onIdle(Carrier carrier) The callback function that perform idle work.
void	onReady(Carrier carrier) The callback function to process the ready notification.
void	onSelfInfoChanged(Carrier carrier, UserInfo userInfo) The callback function to process the self info changed event.

Methods inherited from interface org.elastos.carrier.GroupHandler

onGroupConnected, onGroupMessage, onGroupTitle, onPeerListChanged, onPeerName

Method Detail

onIdle

void onIdle(Carrier carrier)

The callback function that perform idle work.

Parameters:

carrier - Carrier node instance

onConnection

void onConnection(Carrier carrier,
                  ConnectionStatus status)

The callback function to process the self connection status.

Parameters:

carrier - Carrier node instance

status - Current connection status. @see ConnectionStatus

onReady

void onReady(Carrier carrier)

The callback function to process the ready notification. Application should wait this callback invoked before calling any function to interact with friends.

Parameters:

carrier - Carrier node instance

onSelfInfoChanged

void onSelfInfoChanged(Carrier carrier,
                       UserInfo userInfo)

The callback function to process the self info changed event.

Parameters:

carrier - Carrier node instance

userInfo - The updated user information

onFriends

void onFriends(Carrier carrier,
               java.util.List<FriendInfo> friends)

The callback function to iterate the each friend item in friend list.

Parameters:

carrier - Carrier node instance

friends - The friends list.

onFriendConnection

void onFriendConnection(Carrier carrier,
                        java.lang.String friendId,
                        ConnectionStatus status)

The callback function to process the friend connections status changed event.

Parameters:

carrier - carrier node instance.

friendId - The friend's user id.

status - The connection status of friend. @see ConnectionStatus

onFriendInfoChanged

void onFriendInfoChanged(Carrier carrier,
                         java.lang.String friendId,
                         FriendInfo info)

The callback function to process the friend information changed event.

Parameters:

carrier - Carrier node instance

friendId - The friend's user id

info - The update friend information

onFriendPresence

void onFriendPresence(Carrier carrier,
                      java.lang.String friendId,
                      PresenceStatus presence)

The callback function to process the friend presence changed event.

Parameters:

carrier - Carrier node instance

friendId - The friend's user id

presence - The presence status of the friend

onFriendRequest

void onFriendRequest(Carrier carrier,
                     java.lang.String userId,
                     UserInfo info,
                     java.lang.String hello)

The callback function to process the friend request.

Parameters:

carrier - Carrier node instance

userId - The user id who want be friend with current user

info - The user information to `userId`

hello - The PIN for target user, or any application defined content

onFriendAdded

void onFriendAdded(Carrier carrier,
                   FriendInfo friendInfo)

The callback function to process the new friend added event.

Parameters:

carrier - Carrier node instance

friendInfo - The added friend's information

onFriendRemoved

void onFriendRemoved(Carrier carrier,
                     java.lang.String friendId)

The callback function to process the friend removed event.

Parameters:

carrier - Carrier node instance

friendId - The friend's user id

onFriendMessage

void onFriendMessage(Carrier carrier,
                     java.lang.String from,
                     byte[] message,
                     java.util.Date timestamp,
                     boolean isOffline)

The callback function to process the friend message.

Parameters:

carrier - Carrier node instance

from - The id from who send the message

message - The message content

timestamp - The message sent time as the number of miliseconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC)

isOffline - The boolean value means this message is received as offline message or online message. The vlaue of true means the message is received as offline message, otherwise as online message.

onFriendInviteRequest

void onFriendInviteRequest(Carrier carrier,
                           java.lang.String from,
                           java.lang.String data)

The callback function to process the friend invite request.

Parameters:

carrier - Carrier node instance

from - The user id from who send the invite request

data - The application defined data sent from friend

onGroupInvite

void onGroupInvite(Carrier carrier,
                   java.lang.String from,
                   byte[] cookie)

The callback function to process the group invite request.

Parameters:

carrier - Carrier node instance

from - The user id from who send the invite request

cookie - The application defined cookie send from friend