RCServerSDK

Documentation

Index

• Constants
• type RCServer
  • func NewRCServer(appKey, appSecret, format string) (rcServer *RCServer, initError error)
  • func (rcServer *RCServer) ChatroomCreat(chatroomId, chatroomName string) ([]byte, error)
  • func (rcServer *RCServer) ChatroomDestroy(chatroomId string) ([]byte, error)
  • func (rcServer *RCServer) ChatroomQuery(chatroomId string) ([]byte, error)
  • func (rcServer *RCServer) GroupCreat(userId, groupId, groupName string) ([]byte, error)
  • func (rcServer *RCServer) GroupDismiss(userId, groupId string) ([]byte, error)
  • func (rcServer *RCServer) GroupJoin(userId, groupId, groupName string) ([]byte, error)
  • func (rcServer *RCServer) GroupQuit(userId, groupId string) ([]byte, error)
  • func (rcServer *RCServer) GroupRefresh(groupId, groupName string) ([]byte, error)
  • func (rcServer *RCServer) GroupSync(userId string, groupIdAndNameArray []map[string]string) ([]byte, error)
  • func (rcServer *RCServer) MessageBroadcast(fromUserId, objectName, content string) ([]byte, error)
  • func (rcServer *RCServer) MessageChatroomPublish(fromUserId string, toChatroomIds []string, objectName, content string) ([]byte, error)
  • func (rcServer *RCServer) MessageGroupPublish(fromUserId string, toGroupIds []string, ...) ([]byte, error)
  • func (rcServer *RCServer) MessageHistory(date string) ([]byte, error)
  • func (rcServer *RCServer) MessageHistoryDelete(date string) ([]byte, error)
  • func (rcServer *RCServer) MessagePrivatePublish(fromUserId string, toUserIds []string, ...) ([]byte, error)
  • func (rcServer *RCServer) MessageReceive(messageReceiveURL, fromUserId, toUserId, objectName, content, timestamp string) ([]byte, error)
  • func (rcServer *RCServer) MessageSystemPublish(fromUserId string, toUserIds []string, ...) ([]byte, error)
  • func (rcServer *RCServer) UserBlackAdd(userId, blackUserId string) ([]byte, error)
  • func (rcServer *RCServer) UserBlackQuery(userId string) ([]byte, error)
  • func (rcServer *RCServer) UserBlackRemove(userId, blackUserId string) ([]byte, error)
  • func (rcServer *RCServer) UserBlock(userId, minute string) ([]byte, error)
  • func (rcServer *RCServer) UserBlockQuery() ([]byte, error)
  • func (rcServer *RCServer) UserCheckOnline(userId string) ([]byte, error)
  • func (rcServer *RCServer) UserGetToken(userId, name, portraitUri string) ([]byte, error)
  • func (rcServer *RCServer) UserRefresh(userId, name, portraitUri string) ([]byte, error)
  • func (rcServer *RCServer) UserUnblock(userId string) ([]byte, error)

Constants

const (
	RC_SERVER_API_URL    = "https://api.cn.rong.io"
	RC_USER_GET_TOKEN    = "/user/getToken"
	RC_USER_REFRESH      = "/user/refresh"
	RC_USER_CHECK_ONLINE = "/user/checkOnline"
	RC_USER_BLOCK        = "/user/block"
	RC_USER_UNBLOCK      = "/user/unblock"
	RC_USER_BLOCK_QUERY  = "/user/block/query"
	RC_USER_BLACK_ADD    = "/user/blacklist/add"
	RC_USER_BLACK_REMOVE = "/user/blacklist/remove"
	RC_USER_BLACK_QUERY  = "/user/blacklist/query"

	RC_MESSAGE_PRIVATE_PUBLISH  = "/message/private/publish"
	RC_MESSAGE_SYSTEM_PUBLISH   = "/message/system/publish"
	RC_MESSAGE_GROUP_PUBLISH    = "/message/group/publish"
	RC_MESSAGE_CHATROOM_PUBLISH = "/message/chatroom/publish"
	RC_MESSAGE_BROADCAST        = "/message/broadcast"
	RC_MESSAGE_HISTORY          = "/message/history"
	RC_MESSAGE_HISTORY_DELETE   = "/message/history/delete"

	RC_GROUP_CREATE  = "/group/create"
	RC_GROUP_JOIN    = "/group/join"
	RC_GROUP_QUIT    = "/group/quit"
	RC_GROUP_DISMISS = "/group/dismiss"
	RC_GROUP_REFRESH = "/group/refresh"
	RC_GROUP_SYNC    = "/group/sync"

	RC_CHATROOM_CREATE  = "/chatroom/create"
	RC_CHATROOM_DESTROY = "/chatroom/destroy"
	RC_CHATROOM_QUERY   = "/chatroom/query"
)

Types

type RCServer

type RCServer struct {
	// contains filtered or unexported fields
}

func NewRCServer

func NewRCServer(appKey, appSecret, format string) (rcServer *RCServer, initError error)

初始化RCServer

func (*RCServer) ChatroomCreat

func (rcServer *RCServer) ChatroomCreat(chatroomId, chatroomName string) ([]byte, error)

创建聊天室 方法

func (*RCServer) ChatroomDestroy

func (rcServer *RCServer) ChatroomDestroy(chatroomId string) ([]byte, error)

销毁聊天室 方法

func (*RCServer) ChatroomQuery

func (rcServer *RCServer) ChatroomQuery(chatroomId string) ([]byte, error)

查询聊天室信息 方法

func (*RCServer) GroupCreat

func (rcServer *RCServer) GroupCreat(userId, groupId, groupName string) ([]byte, error)

创建群组 方法 创建群组，并将用户加入该群组，用户将可以收到该群的消息。注：其实本方法是加入群组方法 /group/join 的别名。

func (*RCServer) GroupDismiss

func (rcServer *RCServer) GroupDismiss(userId, groupId string) ([]byte, error)

解散群组 方法 将该群解散，所有用户都无法再接收该群的消息。

func (*RCServer) GroupJoin

func (rcServer *RCServer) GroupJoin(userId, groupId, groupName string) ([]byte, error)

加入群组 方法 将用户加入指定群组，用户将可以收到该群的消息。

func (*RCServer) GroupQuit

func (rcServer *RCServer) GroupQuit(userId, groupId string) ([]byte, error)

退出群组 方法 将用户从群中移除，不再接收该群组的消息。

func (*RCServer) GroupRefresh

func (rcServer *RCServer) GroupRefresh(groupId, groupName string) ([]byte, error)

刷新群组信息 方法

func (*RCServer) GroupSync

func (rcServer *RCServer) GroupSync(userId string, groupIdAndNameArray []map[string]string) ([]byte, error)

同步用户所属群组 方法 向融云服务器提交 userId 对应的用户当前所加入的所有群组。

func (*RCServer) MessageBroadcast

func (rcServer *RCServer) MessageBroadcast(fromUserId, objectName, content string) ([]byte, error)

发送广播消息 方法 说明：某发送消息给一个应用下的所有注册用户。 此服务尚未公开提供。如您需要，请提交工单给我们登记。

func (*RCServer) MessageChatroomPublish

func (rcServer *RCServer) MessageChatroomPublish(fromUserId string, toChatroomIds []string, objectName, content string) ([]byte, error)

发送聊天室消息 方法 说明：一个用户向聊天室发送消息

func (*RCServer) MessageGroupPublish

func (rcServer *RCServer) MessageGroupPublish(fromUserId string, toGroupIds []string, objectName, content, pushContent, pushData string) ([]byte, error)

发送群组消息 方法 说明：以一个用户身份向群组发送消息

func (*RCServer) MessageHistory

func (rcServer *RCServer) MessageHistory(date string) ([]byte, error)

消息历史记录下载地址获取 方法 说明：获取 APP 内指定某天某小时内的所有会话消息记录的下载地址

func (*RCServer) MessageHistoryDelete

func (rcServer *RCServer) MessageHistoryDelete(date string) ([]byte, error)

消息历史记录删除 方法 说明：删除 APP 内指定某天某小时内的所有会话消息记录

func (*RCServer) MessagePrivatePublish

func (rcServer *RCServer) MessagePrivatePublish(fromUserId string, toUserIds []string, objectName, content, pushContent, pushData string) ([]byte, error)

发送单聊消息 方法 说明：一个用户向另外一个用户发送消息

func (*RCServer) MessageReceive

func (rcServer *RCServer) MessageReceive(messageReceiveURL, fromUserId, toUserId, objectName, content, timestamp string) ([]byte, error)

同步消息 方法 同步消息时都需要你的服务提供应答，只要有应答，就表示消息已经同步，如果无应答或者应答超时（10秒），融云会再尝试推送2次，如果仍然失败，融云将不再推送此消息。 说明： 1、融云服务器可以将消息数据同步给开发者的应用服务器，开发者应用服务器接收所有在你的 App 下聊天的实时数据(目前支持二人会话数据、群聊数据)，接收数据前需要在开发者后台注册接收地址（目前通过工单提交）。 2、为了验证数据有效性并确保调用者为融云 Server，我们会在每个请求前添加数据签名，详细签名方法参见“API 调用签名规则”,签名信息参数在接收地址的 URL 上提供。 3、调用 Server API 接口发送的消息，不会通过消息路由服务。

func (*RCServer) MessageSystemPublish

func (rcServer *RCServer) MessageSystemPublish(fromUserId string, toUserIds []string, objectName, content, pushContent, pushData string) ([]byte, error)

发送系统消息 说明：一个用户向一个或多个用户发送系统消息

func (*RCServer) UserBlackAdd

func (rcServer *RCServer) UserBlackAdd(userId, blackUserId string) ([]byte, error)

添加用户到黑名单 方法

func (*RCServer) UserBlackQuery

func (rcServer *RCServer) UserBlackQuery(userId string) ([]byte, error)

获取某用户的黑名单列表 方法

func (*RCServer) UserBlackRemove

func (rcServer *RCServer) UserBlackRemove(userId, blackUserId string) ([]byte, error)

从黑名单中移除用户 方法

func (*RCServer) UserBlock

func (rcServer *RCServer) UserBlock(userId, minute string) ([]byte, error)

封禁用户 方法

func (*RCServer) UserBlockQuery

func (rcServer *RCServer) UserBlockQuery() ([]byte, error)

获取被封禁用户 方法

func (*RCServer) UserCheckOnline

func (rcServer *RCServer) UserCheckOnline(userId string) ([]byte, error)

检查用户在线状态 方法 请不要频繁循环调用此接口，而是选择合适的频率和时机调用，此接口设置了一定的频率限制。

func (*RCServer) UserGetToken

func (rcServer *RCServer) UserGetToken(userId, name, portraitUri string) ([]byte, error)

获取 Token 方法

func (*RCServer) UserRefresh

func (rcServer *RCServer) UserRefresh(userId, name, portraitUri string) ([]byte, error)

刷新用户信息 方法

func (*RCServer) UserUnblock

func (rcServer *RCServer) UserUnblock(userId string) ([]byte, error)

解除用户封禁 方法