IMConversation

public class IMConversation

IM Conversation

Show on GitHub

RawData
Undocumented
Declaration
Swift

public typealias RawData = [String : Any]
Show on GitHub

Property

client
The client which this conversation belong to.
Declaration
Swift

public private(set) weak var client: IMClient? { get }
Show on GitHub
ID
The ID of the conversation.
Declaration
Swift

public let ID: String
Show on GitHub
clientID
The ID of the client.
Declaration
Swift

public let clientID: IMClient.Identifier
Show on GitHub
isUnique
Indicates whether the conversation is unique.
Declaration
Swift

public let isUnique: Bool
Show on GitHub
uniqueID
The unique ID of the unique conversation.
Declaration
Swift

public let uniqueID: String?
Show on GitHub
name
The name of the conversation.
Declaration
Swift

public var name: String? { get }
Show on GitHub
creator
The creator of the conversation.
Declaration
Swift

public var creator: String? { get }
Show on GitHub
createdAt
The creation date of the conversation.
Declaration
Swift

public var createdAt: Date? { get }
Show on GitHub
updatedAt
The updated date of the conversation.
Declaration
Swift

public var updatedAt: Date? { get }
Show on GitHub
attributes
The attributes of the conversation.
Declaration
Swift

public var attributes: [String : Any]? { get }
Show on GitHub
members
The members of the conversation.
Declaration
Swift

public var members: [String]? { get }
Show on GitHub
isMuted
Whether the offline notification of this conversation has been muted by the client.
Declaration
Swift

public var isMuted: Bool { get }
Show on GitHub
rawData
Raw data of the conversation.
Declaration
Swift

public private(set) var rawData: RawData { get set }
Show on GitHub
subscript(_:)
Get value via subscript syntax.
Declaration
Swift

public subscript(key: String) -> Any? { get }
Show on GitHub
isOutdated
Indicates whether the data of conversation is outdated, after refresh, this property will be false.
Declaration
Swift

public internal(set) var isOutdated: Bool { get set }
Show on GitHub
lastMessage
The last message of the conversation.
Declaration
Swift

public private(set) var lastMessage: IMMessage? { get set }
Show on GitHub
lastDeliveredAt
The last delivered date of message
Declaration
Swift

public var lastDeliveredAt: Date? { get }
Show on GitHub
lastDeliveredTimestamp
The last delivered timestamp of message
Declaration
Swift

public internal(set) var lastDeliveredTimestamp: Int64? { get set }
Show on GitHub
lastReadAt
The last read date of message
Declaration
Swift

public var lastReadAt: Date? { get }
Show on GitHub
lastReadTimestamp
The last read timestamp of message
Declaration
Swift

public internal(set) var lastReadTimestamp: Int64? { get set }
Show on GitHub
unreadMessageCount
The unread message count of the conversation
Declaration
Swift

public internal(set) var unreadMessageCount: Int { get set }
Show on GitHub
isUnreadMessageContainMention
Indicates whether has unread message mentioning the client.
Declaration
Swift

public var isUnreadMessageContainMention: Bool { get set }
Show on GitHub
memberInfoTable
The table of member infomation.
Declaration
Swift

public var memberInfoTable: [String : MemberInfo]? { get }
Show on GitHub

Function


                    
                    
                    read(message:)

Clear unread messages that its sent timestamp less than the sent timestamp of the parameter message.

Declaration

Swift

public func read(message: IMMessage? = nil)

Parameters


                                message

The default is the last message.

Show on GitHub


                    
                    
                    getMessageReceiptFlag(completion:)

Get the last message receipt timestamps in this conversation. if the timestamps have been updated, then properties of this conversation, lastReadAt and lastDeliveredAt, will be updated. after lastReadAt or lastDeliveredAt has been updated, the client will dispatch relative events, @see IMConversationEvent.

Declaration

Swift

public func getMessageReceiptFlag(completion: @escaping (LCGenericResult<MessageReceiptFlag>) -> Void) throws

Parameters


                                completion

Result callback.

Show on GitHub

fetchReceiptTimestamps()
Fetch the last message receipt timestamps in this conversation. if the timestamps have been updated, then properties of this conversation, lastReadAt and lastDeliveredAt, will be updated. after lastReadAt or lastDeliveredAt has been updated, the client will dispatch relative events, @see IMConversationEvent.
Declaration
Swift

public func fetchReceiptTimestamps() throws
Show on GitHub


                    
                    
                    join(completion:)

Join in this conversation.

Declaration

Swift

public func join(completion: @escaping (LCBooleanResult) -> Void) throws

Parameters


                                completion

callback.

Show on GitHub


                    
                    
                    leave(completion:)

Leave this conversation.

Declaration

Swift

public func leave(completion: @escaping (LCBooleanResult) -> Void) throws

Parameters


                                completion

callback.

Show on GitHub


                    
                    
                    add(members:completion:)

Add members to this conversation.

Declaration

Swift

public func add(members: Set<String>, completion: @escaping (MemberResult) -> Void) throws

Parameters

`members`	The set of member’s ID.
`completion`	callback.

Show on GitHub


                    
                    
                    remove(members:completion:)

Remove members from this conversation.

Declaration

Swift

public func remove(members: Set<String>, completion: @escaping (MemberResult) -> Void) throws

Parameters

`members`	The set of member’s ID.
`completion`	callback.

Show on GitHub


                    
                    
                    countMembers(completion:)

Get count of members in this conversation. if it’s chat-room, the success result means count of online-members.

Declaration

Swift

public func countMembers(completion: @escaping (LCCountResult) -> Void)

Parameters


                                completion

Result callback.

Show on GitHub


                    
                    
                    checkJoined(completion:)

Check whether client joined this conversation.

Declaration

Swift

public func checkJoined(completion: @escaping (LCGenericResult<Bool>) -> Void)

Parameters


                                completion

Result callback.

Show on GitHub


                    
                    
                    mute(completion:)

Mute this conversation.

Declaration

Swift

public func mute(completion: @escaping (LCBooleanResult) -> Void)

Parameters


                                completion

callback.

Show on GitHub


                    
                    
                    unmute(completion:)

Unmute this conversation.

Declaration

Swift

public func unmute(completion: @escaping (LCBooleanResult) -> Void)

Parameters


                                completion

callback.

Show on GitHub


                    
                    
                    refresh(completion:)

Refresh conversation’s data.

Declaration

Swift

public func refresh(completion: @escaping (LCBooleanResult) -> Void) throws

Parameters


                                completion

callback

Show on GitHub


                    
                    
                    update(attribution:completion:)

Update conversation’s data.

Declaration

Swift

public func update(attribution data: [String : Any], completion: @escaping (LCBooleanResult) -> Void) throws

Parameters

`data`	The data to be updated.
`completion`	callback.

Show on GitHub


                    
                    
                    fetchMemberInfoTable(limit:offset:completion:)

Fetching the table of member infomation in this conversation. The result will be cached in the property memberInfoTable.

Declaration

Swift

public func fetchMemberInfoTable(
    limit: Int = 500,
    offset: Int? = nil,
    completion: @escaping (LCBooleanResult) -> Void)

Parameters

`limit`	The max number of results, default is `500`.
`offset`	The number of objects to skip.
`completion`	Result of callback.

Show on GitHub


                    
                    
                    getMemberInfo(by:completion:)

Get infomation of one member in the conversation.

Declaration

Swift

public func getMemberInfo(by memberID: String, completion: @escaping (LCGenericResult<MemberInfo?>) -> Void)

Parameters

`memberID`	The ID of the member.
`completion`	Result of callback.

Show on GitHub


                    
                    
                    update(role:ofMember:completion:)

Updating role of the member in the conversaiton.

Throws

If role parameter is owner, throw error.

Declaration

Swift

public func update(
    role: MemberRole,
    ofMember memberID: String,
    completion: @escaping (LCBooleanResult) -> Void)
    throws

Parameters

`role`	The role will be updated.
`memberID`	The ID of the member who will be updated.
`completion`	Result of callback.

Show on GitHub


                    
                    
                    block(members:completion:)

Blocking members in the conversation.

Throws

When parameter members is empty.

Declaration

Swift

public func block(members: Set<String>, completion: @escaping (MemberResult) -> Void) throws

Parameters

`members`	The members will be blocked.
`completion`	Result of callback.

Show on GitHub


                    
                    
                    unblock(members:completion:)

Unblocking members in the conversation.

Throws

When parameter members is empty.

Declaration

Swift

public func unblock(members: Set<String>, completion: @escaping (MemberResult) -> Void) throws

Parameters

`members`	The members will be unblocked.
`completion`	Result of callback.

Show on GitHub


                    
                    
                    getBlockedMembers(limit:next:completion:)

Get the blocked members in the conversation.

Throws

When limit out of range.

Declaration

Swift

public func getBlockedMembers(
    limit: Int = 50,
    next: String? = nil,
    completion: @escaping (LCGenericResult<BlockedMembersResult>) -> Void)
    throws

Parameters

`limit`	Count limit.
`next`	Offset.
`completion`	Result of callback.

Show on GitHub


                    
                    
                    checkBlocking(member:completion:)

Check if one member has been blocked in the conversation.

Declaration

Swift

public func checkBlocking(
    member ID: String,
    completion: @escaping (LCGenericResult<Bool>) -> Void)

Parameters

`ID`	The ID of member.
`completion`	Result of callback.

Show on GitHub


                    
                    
                    mute(members:completion:)

Muting members in the conversation.

Throws

When parameter members is empty.

Declaration

Swift

public func mute(members: Set<String>, completion: @escaping (MemberResult) -> Void) throws

Parameters

`members`	The members will be muted.
`completion`	Result of callback.

Show on GitHub


                    
                    
                    unmute(members:completion:)

Unmuting members in the conversation.

Throws

When parameter members is empty.

Declaration

Swift

public func unmute(members: Set<String>, completion: @escaping (MemberResult) -> Void) throws

Parameters

`members`	The members will be unmuted.
`completion`	Result of callback.

Show on GitHub


                    
                    
                    getMutedMembers(limit:next:completion:)

Get the muted members in the conversation.

Throws

When parameter limit out of range.

Declaration

Swift

public func getMutedMembers(
    limit: Int = 50,
    next: String? = nil,
    completion: @escaping (LCGenericResult<MutedMembersResult>) -> Void)
    throws

Parameters

`limit`	Count limit.
`next`	Offset.
`completion`	Result of callback.

Show on GitHub


                    
                    
                    checkMuting(member:completion:)

Check if one member has been muted in the conversation.

Declaration

Swift

public func checkMuting(
    member ID: String,
    completion: @escaping (LCGenericResult<Bool>) -> Void)

Parameters

`ID`	The ID of member.
`completion`	Result of callback.

Show on GitHub


                    
                    
                    insertFailedMessageToCache(_:completion:)

Undocumented

Declaration

Swift

public func insertFailedMessageToCache(
    _ message: IMMessage,
    completion: @escaping (LCBooleanResult) -> Void)
    throws

Show on GitHub


                    
                    
                    removeFailedMessageFromCache(_:completion:)

Undocumented

Declaration

Swift

public func removeFailedMessageFromCache(
    _ message: IMMessage,
    completion: @escaping (LCBooleanResult) -> Void)
    throws

Show on GitHub

Message Sending

MessageSendOptions
Message Sending Option
See more
Declaration
Swift

public struct MessageSendOptions : OptionSet
Show on GitHub


                    
                    
                    send(message:options:priority:pushData:progressQueue:progress:completion:)

Send Message.

Declaration

Swift

public func send(
    message: IMMessage,
    options: MessageSendOptions = .default,
    priority: IMChatRoom.MessagePriority? = nil,
    pushData: [String: Any]? = nil,
    progressQueue: DispatchQueue = .main,
    progress: ((Double) -> Void)? = nil,
    completion: @escaping (LCBooleanResult) -> Void)
    throws

Parameters

`message`	The message to be sent. Properties such as `ID` and `sentTimeStamp` are updated.
`options`	@see `MessageSendOptions`.
`priority`	@see `IMChatRoom.MessagePriority`.
`pushData`	The push data of APNs.
`progressQueue`	The queue where the progress be called. default is main.
`progress`	The file uploading progress.
`completion`	callback.

Show on GitHub

Message Updating


                    
                    
                    update(oldMessage:to:progressQueue:progress:completion:)

Update the content of a sent message.

Declaration

Swift

public func update(
    oldMessage: IMMessage,
    to newMessage: IMMessage,
    progressQueue: DispatchQueue = .main,
    progress: ((Double) -> Void)? = nil,
    completion: @escaping (LCBooleanResult) -> Void)
    throws

Parameters

`oldMessage`	The sent message to be updated.
`newMessage`	The message which has new content.
`progressQueue`	The queue where the progress be called, default is main.
`progress`	The file uploading progress.
`completion`	Result callback.

Show on GitHub


                    
                    
                    recall(message:completion:)

Recall a sent message.

Declaration

Swift

public func recall(
    message: IMMessage,
    completion: @escaping (LCGenericResult<IMRecalledMessage>) -> Void)
    throws

Parameters

`message`	The message has been sent.
`completion`	Result callback.

Show on GitHub

Message Receipt Timestamp

MessageReceiptFlag
The timestamp flag of message receipt.
See more
Declaration
Swift

public struct MessageReceiptFlag
Show on GitHub

Message Query

limitRangeOfMessageQuery
The limit of the messge query result.
Declaration
Swift

public static let limitRangeOfMessageQuery: ClosedRange<Int>
Show on GitHub
MessageQueryEndpoint
The endpoint of the message queue.
See more
Declaration
Swift

public struct MessageQueryEndpoint
Show on GitHub
MessageQueryDirection
The query direction.
See more
Declaration
Swift

public enum MessageQueryDirection : Int
Show on GitHub
MessageQueryPolicy
Policy of Message Query
- default: If using local storage, it is cacheThenNetwork. If not using local storage, it is onlyNetwork.
- onlyNetwork: Only query remote server
- onlyCache: Only query local storage
- cacheThenNetwork: Query local storage firstly, if not get result, then query remote server.
See more
Declaration
Swift

public enum MessageQueryPolicy
Show on GitHub


                    
                    
                    queryMessage(start:end:direction:limit:type:policy:completion:)

Message Query.

Declaration

Swift

public func queryMessage(
    start: MessageQueryEndpoint? = nil,
    end: MessageQueryEndpoint? = nil,
    direction: MessageQueryDirection? = nil,
    limit: Int = 20,
    type: IMMessageCategorizing.MessageType? = nil,
    policy: MessageQueryPolicy = .default,
    completion: @escaping (LCGenericResult<[IMMessage]>) -> Void)
    throws

Parameters

`start`	start endpoint, @see `MessageQueryEndpoint`.
`end`	end endpoint, @see `MessageQueryEndpoint`.
`direction`	@see `MessageQueryDirection`. default is `MessageQueryDirection.newToOld`.
`limit`	The limit of the query result, should in range `limitRangeOfMessageQuery`. default is 20.
`type`	@see `IMMessageCategorizing.MessageType`. if this parameter did set, `policy` will always be `.onlyNetwork`.
`policy`	@see `IMConversation.MessageQueryPolicy`. if `client.options` contains `.usingLocalStorage`, then default is `.cacheThenNetwork`, else default is `.onlyNetwork`.
`completion`	callback.

Show on GitHub

Conversation Member

MemberResult
Result for member operation.
- allSucceeded: Operation for all members are succeeded.
- failure: Operation failed.
- slicing: Operation for part members are succeeded, and for part members are failed.
See more
Declaration
Swift

public enum MemberResult : LCResultType
Show on GitHub

Member Info

MemberRole
Role of the member in the conversation. Privilege: owner > manager > member.
- owner: Who owns the conversation.
- manager: Who can manage the conversation.
- member: General member.
See more
Declaration
Swift

public enum MemberRole : String
Show on GitHub
MemberInfo
The infomation of one member in the conversation.
See more
Declaration
Swift

public struct MemberInfo
Show on GitHub

Member Blacklist


                    
                    
                    BlockedMembersResult

Undocumented

Declaration

Swift

public typealias BlockedMembersResult = (members: [String], next: String?)

Show on GitHub

Member Shutup


                    
                    
                    MutedMembersResult

Undocumented

Declaration

Swift

public typealias MutedMembersResult = (members: [String], next: String?)

Show on GitHub