cn.leancloud.im

Interface SignatureFactory

All Known Implementing Classes:

LCUserSignatureFactory

public interface SignatureFactory

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SignatureFactory.SignatureException 签名异常类

Field Summary

Fields

Modifier and Type	Field and Description
static int	SIGNATURE_FAILED_LOGIN

Method Summary

Modifier and Type	Method and Description
Signature	createBlacklistSignature(String clientId, String conversationId, List<String> memberIds, String action) 实现黑名单相关的签名计算
Signature	createConversationSignature(String conversationId, String clientId, List<String> targetIds, String action) 实现 LCIMConversation 相关的签名计算
Signature	createSignature(String peerId, List<String> watchIds) 实现一个基础签名方法 其中的签名算法会在SessionManager和 LCIMClient(V2) 中被使用

Field Detail

SIGNATURE_FAILED_LOGIN

static final int SIGNATURE_FAILED_LOGIN

See Also:

Constant Field Values

Method Detail

createSignature

Signature createSignature(String peerId,
                          List<String> watchIds)
                   throws SignatureFactory.SignatureException

实现一个基础签名方法 其中的签名算法会在SessionManager和 LCIMClient(V2) 中被使用

Parameters:

peerId - peer id

watchIds - watch peer ids.

Returns:

signature object

Throws:

SignatureFactory.SignatureException - 如果签名计算中间发生任何问题请抛出本异常

createConversationSignature

Signature createConversationSignature(String conversationId,
                                      String clientId,
                                      List<String> targetIds,
                                      String action)
                               throws SignatureFactory.SignatureException

实现 LCIMConversation 相关的签名计算

Parameters:

conversationId - conversation id

clientId - owner client id

targetIds - 操作所对应的数据

action - - 此次行为的动作，行为分别对应常量 invite（加群和邀请）和 kick（踢出群）

Returns:

signature object

Throws:

SignatureFactory.SignatureException - 如果签名计算中间发生任何问题请抛出本异常

createBlacklistSignature

Signature createBlacklistSignature(String clientId,
                                   String conversationId,
                                   List<String> memberIds,
                                   String action)
                            throws SignatureFactory.SignatureException

实现黑名单相关的签名计算

Parameters:

clientId - 当前登录用户的 id，必须

conversationId - 目标对话的 id，可选

memberIds - 目标成员的 id，可选

action - 操作类型的字符串，有如下集中类型： conversation-block-clients 在对话中拉黑部分成员，此时 conversationId 和 memberIds 是必须的。 conversation-unblock-clients 在对话中解禁部分成员，此时 conversationId 和 memberIds 是必须的。

Returns:

signature object

Throws:

SignatureFactory.SignatureException - 如果签名计算中间发生任何问题请抛出本异常