JMSGChatRoom Class Reference

Inherits from NSObject
Declared in JMSGChatRoom.h

Overview

  • 聊天室 *
  • 主要特点

    *

  • 聊天室的消息没有推送通知和离线保存,也没有常驻成员的概念,只要进入聊天室即可接收消息,开始聊天, 一旦退出聊天室,不再会接收到任何消息、通知和提醒。 *
  • 发送消息

    *

  • 聊天室消息的发送与单聊、群聊是一样的,通用的发送接口 *
  • 接收消息

    *

  • 聊天室消息的接收与单聊、群聊做了区分,聊天室消息的接收将通过 JMSGConversationDelegate 类里的 onReceiveChatRoomConversation:messages: 方法通知到上层 *

Other Methods

+ getChatRoomListWithAppKey:start:count:completionHandler:

分页获取聊天室详情

+ (void)getChatRoomListWithAppKey:(NSString *JMSG_NULLABLE)appKey start:(NSInteger)start count:(NSInteger)count completionHandler:(JMSGCompletionHandler JMSG_NULLABLE)handler

Parameters

appKey

选填,为 nil 则获取当前应用下的聊天室

start

分页获取的下标,第一页从 index = 0 开始

count

一页的数量,每页最大值是 50

handler

结果回调. 正常返回时 resultObject 类型是 NSArray

Discussion

该接口总是向服务器端发起请求.

Declared In

JMSGChatRoom.h

+ getMyChatRoomListCompletionHandler:

获取当前用户已加入的聊天室列表

+ (void)getMyChatRoomListCompletionHandler:(JMSGCompletionHandler JMSG_NULLABLE)handler

Parameters

handler

结果回调. 正常返回时 resultObject 类型是 NSArray

Discussion

该接口总是向服务器端发起请求.

Declared In

JMSGChatRoom.h

+ getChatRoomInfosWithRoomIds:completionHandler:

获取聊天室详情

+ (void)getChatRoomInfosWithRoomIds:(NSArray *JMSG_NONNULL)roomIds completionHandler:(JMSGCompletionHandler JMSG_NULLABLE)handler

Parameters

roomIds

待获取详情的聊天室 ID 数组

handler

结果回调. 正常返回时 resultObject 类型是 NSArray

Discussion

该接口总是向服务器端发起请求.

Declared In

JMSGChatRoom.h

+ enterChatRoomWithRoomId:completionHandler:

加入聊天室

+ (void)enterChatRoomWithRoomId:(NSString *JMSG_NONNULL)roomId completionHandler:(JMSGCompletionHandler JMSG_NULLABLE)handler

Parameters

roomId

聊天室 id

handler

结果回调. error = nil 表示加入成功,resultObject 为 JMSGConversation 类型

Discussion

成功进入聊天室之后,会将聊天室中最近若干条聊天记录同步下来并以 onReceiveChatRoomConversation: 事件的形式通知到上层。

Declared In

JMSGChatRoom.h

+ leaveChatRoomWithRoomId:completionHandler:

退出聊天室

+ (void)leaveChatRoomWithRoomId:(NSString *JMSG_NONNULL)roomId completionHandler:(JMSGCompletionHandler JMSG_NULLABLE)handler

Parameters

roomId

聊天室 id

handler

结果回调. error = nil 表示加入成功.

Discussion

退出聊天室后获取不到任何消息和通知.

Declared In

JMSGChatRoom.h

Group basic fields 群组基本属性

  roomID

聊天室 id

@property (nonatomic, strong, readonly) NSString *roomID

Declared In

JMSGChatRoom.h

  name

名称

@property (nonatomic, strong, readonly) NSString *name

Declared In

JMSGChatRoom.h

  appkey

聊天室所属应用 AppKey

@property (nonatomic, strong, readonly) NSString *appkey

Declared In

JMSGChatRoom.h

  desc

描述信息

@property (nonatomic, strong, readonly) NSString *desc

Declared In

JMSGChatRoom.h

  totalMemberCount

聊天室人数

@property (nonatomic, assign, readonly) NSInteger totalMemberCount

Declared In

JMSGChatRoom.h

  maxMemberCount

聊天室最大人数限制

@property (nonatomic, strong, readonly) NSString *maxMemberCount

Declared In

JMSGChatRoom.h

  ctime

聊天室的创建时间

@property (nonatomic, strong, readonly) NSNumber *ctime

Declared In

JMSGChatRoom.h

– getChatRoomOwnerInfo:

聊天室创建者

- (void)getChatRoomOwnerInfo:(JMSGCompletionHandler JMSG_NULLABLE)handler

Parameters

handler

结果回调. error = nil 表示获取成功, resultObject 为 JMSGUser 类型.

Declared In

JMSGChatRoom.h

– displayName

聊天室的展示名

- (NSString *)displayName

Discussion

如果 chatroom.name 为空, 则此接口会返回 chatroom.roomID.

Declared In

JMSGChatRoom.h