CubeClient (Cube Server Client API Documents)

java.lang.Object
- cube.client.CubeClient

public final class CubeClient
extends java.lang.Object

服务器客户端程序。

嵌套类概要

嵌套类
限定符和类型类和说明

protected class CubeClient.Daemon
守护任务。

嵌套类
限定符和类型	类和说明
`protected class`	`CubeClient.Daemon` 守护任务。

字段概要

字段
限定符和类型	字段和说明
`protected ContactListener`	`contactListener`
`protected java.util.concurrent.ConcurrentMap<java.lang.String,MessageReceiver>`	`messageReceiverMap`
`static java.lang.String`	`NAME`
`static java.lang.String`	`VERSION`

构造器概要

构造器
构造器和说明

CubeClient(java.lang.String address)
构造函数。

CubeClient(java.lang.String address, int port)
构造函数。

构造器
构造器和说明
`CubeClient(java.lang.String address)` 构造函数。
`CubeClient(java.lang.String address, int port)` 构造函数。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`deregisterListener(ContactListener listener)` 注销联系人监听器。
`boolean`	`deregisterMessageReceiveListener(Contact contact)` 注销监听指定联系人接收消息的监听器。
`boolean`	`deregisterMessageReceiveListener(Group group)` 注销监听指定群组消息的监听器。
`void`	`destroy()` 销毁客户端。
`Contact`	`getContact(java.lang.String domain, java.lang.Long id)` 获取指定 ID 的联系人。
`Group`	`getGroup(java.lang.String domain, java.lang.Long id)` 获取指定 ID 的群组。
`java.lang.Long`	`getId()` 获取客户端 ID 。
`protected MessageReceiveListener`	`getMessageReceiveListener(Contact contact)`
`protected MessageReceiveListener`	`getMessageReceiveListener(Group group)`
`java.util.List<Contact>`	`getOnlineContacts()` 获取当前连接服务器上所有在线的联系人。
`boolean`	`pushMessageWithPretender(Contact receiver, Contact pretender, Device device, JSONObject payload)` 使用伪装身份推送消息。
`boolean`	`pushMessageWithPretender(Contact receiver, Contact pretender, JSONObject payload)` 使用伪装身份推送消息。
`MessageIterator`	`queryMessages(long beginning, Contact contact)` 查询与指定联系人相关的消息。
`boolean`	`registerListener(ContactListener listener)` 注册联系人监听器。
`boolean`	`registerMessageReceiveListener(Contact contact, MessageReceiveListener listener)` 注册监听指定联系人接收到的消息。
`boolean`	`registerMessageReceiveListener(Group group, MessageReceiveListener listener)` 注册监听指定群组消息的监听器。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - VERSION
```
public static final java.lang.String VERSION
```
    另请参阅:
    
    常量字段值
  - NAME
```
public static final java.lang.String NAME
```
    另请参阅:
    
    常量字段值
  - contactListener
```
protected ContactListener contactListener
```
  - messageReceiverMap
```
protected java.util.concurrent.ConcurrentMap<java.lang.String,MessageReceiver> messageReceiverMap
```
- 构造器详细资料
  - CubeClient
```
public CubeClient(java.lang.String address)
```
    构造函数。
    
    参数:
    
    address - 服务器地址。
  - CubeClient
```
public CubeClient(java.lang.String address,
                  int port)
```
    构造函数。
    
    参数:
    
    address - 服务器地址。
    
    port - 服务器端口。
- 方法详细资料
  - getId
```
public java.lang.Long getId()
```
    获取客户端 ID 。
    
    返回:
    
    返回客户端 ID 。
  - destroy
```
public void destroy()
```
    销毁客户端。
  - registerListener
```
public boolean registerListener(ContactListener listener)
```
    注册联系人监听器。仅对当前连接的服务器有效。
    
    参数:
    
    listener - 联系人监听器。
    
    返回:
    
    返回操作是否有效。
  - deregisterListener
```
public boolean deregisterListener(ContactListener listener)
```
    注销联系人监听器。仅对当前连接的服务器有效。
    
    参数:
    
    listener - 联系人监听器。
    
    返回:
    
    返回操作是否有效。
  - registerMessageReceiveListener
```
public boolean registerMessageReceiveListener(Contact contact,
                                              MessageReceiveListener listener)
```
    注册监听指定联系人接收到的消息。
    
    参数:
    
    contact - 指定被监听的联系人。
    
    listener - 指定监听器。
    
    返回:
    
    返回操作是否有效。
  - deregisterMessageReceiveListener
```
public boolean deregisterMessageReceiveListener(Contact contact)
```
    注销监听指定联系人接收消息的监听器。
    
    参数:
    
    contact - 指定被监听的联系人。
    
    返回:
    
    返回操作是否有效。
  - registerMessageReceiveListener
```
public boolean registerMessageReceiveListener(Group group,
                                              MessageReceiveListener listener)
```
    注册监听指定群组消息的监听器。
    
    参数:
    
    group - 指定被监听的群组。
    
    listener - 指定监听器。
    
    返回:
    
    返回操作是否有效。
  - deregisterMessageReceiveListener
```
public boolean deregisterMessageReceiveListener(Group group)
```
    注销监听指定群组消息的监听器。
    
    参数:
    
    group - 指定被监听的群组。
    
    返回:
    
    返回操作是否有效。
  - getOnlineContacts
```
public java.util.List<Contact> getOnlineContacts()
```
    获取当前连接服务器上所有在线的联系人。
    
    返回:
    
    返回当前连接服务器上所有在线的联系人。
  - getContact
```
public Contact getContact(java.lang.String domain,
                          java.lang.Long id)
```
    获取指定 ID 的联系人。
    
    参数:
    
    domain - 指定域名称。
    
    id - 指定联系人的 ID 。
    
    返回:
    
    返回指定的联系人实例。
  - getGroup
```
public Group getGroup(java.lang.String domain,
                      java.lang.Long id)
```
    获取指定 ID 的群组。
    
    参数:
    
    domain - 指定域名称。
    
    id - 指定群组的 ID 。
    
    返回:
    
    返回指定的群组实例，如果没有找到该群组返回 null 值。
  - pushMessageWithPretender
```
public boolean pushMessageWithPretender(Contact receiver,
                                        Contact pretender,
                                        JSONObject payload)
```
    使用伪装身份推送消息。
    
    参数:
    
    receiver - 指定消息接收者。
    
    pretender - 指定伪装的联系人。
    
    payload - 指定消息数据负载。
    
    返回:
    
    如果消息被服务器处理返回 true 。
  - pushMessageWithPretender
```
public boolean pushMessageWithPretender(Contact receiver,
                                        Contact pretender,
                                        Device device,
                                        JSONObject payload)
```
    使用伪装身份推送消息。
    
    参数:
    
    receiver - 指定消息接收者。
    
    pretender - 指定伪装的联系人。
    
    device - 指定发送消息的设备。
    
    payload - 指定消息数据负载。
    
    返回:
    
    如果消息被服务器处理返回 true 。
  - queryMessages
```
public MessageIterator queryMessages(long beginning,
                                     Contact contact)
```
    查询与指定联系人相关的消息。
    
    参数:
    
    beginning -
    
    contact -
    
    返回:
  - getMessageReceiveListener
```
protected MessageReceiveListener getMessageReceiveListener(Contact contact)
```
  - getMessageReceiveListener
```
protected MessageReceiveListener getMessageReceiveListener(Group group)
```

类 CubeClient

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

VERSION

NAME

contactListener

messageReceiverMap

构造器详细资料

CubeClient

CubeClient

方法详细资料

getId

destroy

registerListener

deregisterListener

registerMessageReceiveListener

deregisterMessageReceiveListener

registerMessageReceiveListener

deregisterMessageReceiveListener

getOnlineContacts

getContact

getGroup

pushMessageWithPretender

pushMessageWithPretender

queryMessages

getMessageReceiveListener

getMessageReceiveListener