cn.leancloud.im.v2

Class LCIMClient

java.lang.Object

cn.leancloud.im.v2.LCIMClient

public class LCIMClient
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LCIMClient.LCIMClientStatus 当前client的状态

Method Summary

Modifier and Type	Method and Description
void	close(LCIMClientCallback callback) close client.
void	createChatRoom(List<String> conversationMembers, String name, Map<String,Object> attributes, boolean isUnique, LCIMConversationCreatedCallback callback) Create a new Chatroom
void	createChatRoom(String name, Map<String,Object> attributes, LCIMConversationCreatedCallback callback) Create a new Chatroom
void	createConversation(List<String> conversationMembers, Map<String,Object> attributes, LCIMConversationCreatedCallback callback) Create a new Conversation
void	createConversation(List<String> members, String name, Map<String,Object> attributes, boolean isTransient, boolean isUnique, LCIMConversationCreatedCallback callback) Create a new Conversation
void	createConversation(List<String> members, String name, Map<String,Object> attributes, boolean isTransient, LCIMConversationCreatedCallback callback) Create a new Conversation
void	createConversation(List<String> conversationMembers, String name, Map<String,Object> attributes, LCIMConversationCreatedCallback callback) Create a new Conversation
void	createTemporaryConversation(List<String> conversationMembers, int ttl, LCIMConversationCreatedCallback callback) Create a new temporary Conversation
void	createTemporaryConversation(List<String> conversationMembers, LCIMConversationCreatedCallback callback) Create a new temporary Conversation
LCIMConversation	getChatRoom(String conversationId) get an existed Chatroom by id
LCIMConversationsQuery	getChatRoomQuery() 获取开放聊天室的查询对象 开发者拿到这个对象之后，就可以像 IMConversationsQuery 以前的接口一样对目标属性（如名字）等进行查询。
static LCIMClientEventHandler	getClientEventHandler()
String	getClientId() 获取当前用户的 clientId
static int	getClientsCount() count used clients.
void	getClientStatus(LCIMClientStatusCallback callback)
LCIMConversation	getConversation(String conversationId) get conversation by id
LCIMConversation	getConversation(String conversationId, boolean isTransient, boolean isTemporary) get an existed conversation
LCIMConversation	getConversation(String conversationId, int convType) get conversation by id and type
LCIMConversationsQuery	getConversationsQuery() 获取 IMConversationsQuery 对象，以此来查询 conversation
static String	getDefaultClient() get default clientId.
String	getInstallationId()
static LCIMClient	getInstance(cn.leancloud.session.LCConnectionManager connectionManager, String clientId, LCInstallation installation) get IMClient instance by clientId.
static LCIMClient	getInstance(LCUser user) get IMClient instance by LCUser
static LCIMClient	getInstance(LCUser user, String tag) get IMClient instance by LCUser
static LCIMClient	getInstance(String clientId) get IMClient instance by clientId.
static LCIMClient	getInstance(String clientId, String tag) get IMClient instance by clientId and tag.
void	getOnlineClients(List<String> clients, LCIMOnlineClientsCallback callback) Query online clients.
LCIMConversation	getServiceConversation(String conversationId) get an existed Service Conversation
LCIMConversationsQuery	getServiceConversationQuery() 获取服务号的查询对象 开发者拿到这个对象之后，就可以像 IMConversationsQuery 以前的接口一样对目标属性（如名字）等进行查询。
LCIMConversation	getTemporaryConversation(String conversationId) get an existed temporary conversation
protected void	localClose()
void	open(LCIMClientCallback callback) Open client.
void	open(LCIMClientOpenOption option, LCIMClientCallback callback) Open Client with options.
static LCIMClient	peekInstance(String clientId) peek IMClient instance by clientId.
static void	setClientEventHandler(LCIMClientEventHandler handler) 设置 IMClient 的事件处理单元，包括 Client 断开链接和重连成功事件
void	updateRealtimeSessionToken(String token, long expiredInSec) [internal use only] update realtime session token

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setClientEventHandler

public static void setClientEventHandler(LCIMClientEventHandler handler)

设置 IMClient 的事件处理单元，包括 Client 断开链接和重连成功事件

Parameters:

handler - event handler.

getClientEventHandler

public static LCIMClientEventHandler getClientEventHandler()

getInstallationId

public String getInstallationId()

getInstance

public static LCIMClient getInstance(String clientId)

get IMClient instance by clientId.

Parameters:

clientId - client id.

Returns:

imclient instance.

peekInstance

public static LCIMClient peekInstance(String clientId)

peek IMClient instance by clientId.

Parameters:

clientId - client id.

Returns:

imclient instance, NULL if not existed.

getInstance

public static LCIMClient getInstance(cn.leancloud.session.LCConnectionManager connectionManager,
                                     String clientId,
                                     LCInstallation installation)

get IMClient instance by clientId.

Parameters:

connectionManager - connection manager.

clientId - client id.

installation - installation id.

Returns:

imclient instance.

getClientsCount

public static int getClientsCount()

count used clients.

Returns:

current client count.

getDefaultClient

public static String getDefaultClient()

get default clientId.

Returns:

the default client id.

getInstance

public static LCIMClient getInstance(String clientId,
                                     String tag)

get IMClient instance by clientId and tag.

Parameters:

clientId - client id.

tag - optional tag.

Returns:

imclient instance.

getInstance

public static LCIMClient getInstance(LCUser user)

get IMClient instance by LCUser

Parameters:

user - user instance.

Returns:

imclient instance.

getInstance

public static LCIMClient getInstance(LCUser user,
                                     String tag)

get IMClient instance by LCUser

Parameters:

user - user instance.

tag - client tag.

Returns:

imclient instance.

getClientStatus

public void getClientStatus(LCIMClientStatusCallback callback)

getClientId

public String getClientId()

获取当前用户的 clientId

Returns:

返回clientId

open

public void open(LCIMClientCallback callback)

Open client.

Parameters:

callback - callback function.

open

public void open(LCIMClientOpenOption option,
                 LCIMClientCallback callback)

Open Client with options.

Parameters:

option - open option.

callback - callback function.

getOnlineClients

public void getOnlineClients(List<String> clients,
                             LCIMOnlineClientsCallback callback)

Query online clients.

Parameters:

clients - client list.

callback - callback function.

createConversation

public void createConversation(List<String> conversationMembers,
                               Map<String,Object> attributes,
                               LCIMConversationCreatedCallback callback)

Create a new Conversation

Parameters:

conversationMembers - member list.

attributes - attribute map.

callback - callback function.

createConversation

public void createConversation(List<String> conversationMembers,
                               String name,
                               Map<String,Object> attributes,
                               LCIMConversationCreatedCallback callback)

Create a new Conversation

Parameters:

conversationMembers - member list.

name - conversation name.

attributes - attribute map.

callback - callback function.

createConversation

public void createConversation(List<String> members,
                               String name,
                               Map<String,Object> attributes,
                               boolean isTransient,
                               LCIMConversationCreatedCallback callback)

Create a new Conversation

Parameters:

members - member list.

name - conversation name.

attributes - attribute map.

isTransient - flag of transient.

callback - callback function.

createConversation

public void createConversation(List<String> members,
                               String name,
                               Map<String,Object> attributes,
                               boolean isTransient,
                               boolean isUnique,
                               LCIMConversationCreatedCallback callback)

Create a new Conversation

Parameters:

members - member list.

name - conversation name.

attributes - attribute map.

isTransient - flag of transient.

isUnique - flag of unique.

callback - callback function.

createTemporaryConversation

public void createTemporaryConversation(List<String> conversationMembers,
                                        LCIMConversationCreatedCallback callback)

Create a new temporary Conversation

Parameters:

conversationMembers - member list.

callback - callback function.

createTemporaryConversation

public void createTemporaryConversation(List<String> conversationMembers,
                                        int ttl,
                                        LCIMConversationCreatedCallback callback)

Create a new temporary Conversation

Parameters:

conversationMembers - member list.

ttl - ttl value in seconds.

callback - callback function.

createChatRoom

public void createChatRoom(List<String> conversationMembers,
                           String name,
                           Map<String,Object> attributes,
                           boolean isUnique,
                           LCIMConversationCreatedCallback callback)

Create a new Chatroom

Parameters:

conversationMembers - member list.

name - conversation name

attributes - conversation attribute map.

isUnique - deprecated chatroom is always not unique.

callback - callback function.

createChatRoom

public void createChatRoom(String name,
                           Map<String,Object> attributes,
                           LCIMConversationCreatedCallback callback)

Create a new Chatroom

Parameters:

name - conversation name

attributes - conversation attribute map.

callback - callback function.

getConversation

public LCIMConversation getConversation(String conversationId)

get conversation by id

Parameters:

conversationId - conversation id.

Returns:

conversation instance.

getConversation

public LCIMConversation getConversation(String conversationId,
                                        int convType)

get conversation by id and type

Parameters:

conversationId - conversation id.

convType - conversation type.

Returns:

conversation instance.

getConversation

public LCIMConversation getConversation(String conversationId,
                                        boolean isTransient,
                                        boolean isTemporary)

get an existed conversation

Parameters:

conversationId - conversation id.

isTransient - flag of transient.

isTemporary - flag of temporary.

Returns:

conversation instance.

getChatRoom

public LCIMConversation getChatRoom(String conversationId)

get an existed Chatroom by id

Parameters:

conversationId - conversation id.

Returns:

chatroom conversation instance.

getServiceConversation

public LCIMConversation getServiceConversation(String conversationId)

get an existed Service Conversation

Parameters:

conversationId - conversation id.

Returns:

service conversation instance.

getTemporaryConversation

public LCIMConversation getTemporaryConversation(String conversationId)

get an existed temporary conversation

Parameters:

conversationId - conversation id.

Returns:

temporary conversation instance.

getConversationsQuery

public LCIMConversationsQuery getConversationsQuery()

获取 IMConversationsQuery 对象，以此来查询 conversation

Returns:

ConversationsQuery instance

getServiceConversationQuery

public LCIMConversationsQuery getServiceConversationQuery()

获取服务号的查询对象 开发者拿到这个对象之后，就可以像 IMConversationsQuery 以前的接口一样对目标属性（如名字）等进行查询。

Returns:

ConversationsQuery instance

getChatRoomQuery

public LCIMConversationsQuery getChatRoomQuery()

获取开放聊天室的查询对象 开发者拿到这个对象之后，就可以像 IMConversationsQuery 以前的接口一样对目标属性（如名字）等进行查询。

Returns:

ConversationsQuery instance

close

public void close(LCIMClientCallback callback)

close client.

Parameters:

callback - callback function.

updateRealtimeSessionToken

public void updateRealtimeSessionToken(String token,
                                       long expiredInSec)

[internal use only] update realtime session token

Parameters:

token - session token

expiredInSec - expired interval.

localClose

protected void localClose()