IMClient

public class IMClient

IM Client

Show on GitHub

Property

lengthRangeOfClientID
Length range of the client ID.
Declaration
Swift

public static let lengthRangeOfClientID: ClosedRange<Int>
Show on GitHub
reservedValueOfTag
Reserved value of the tag.
Declaration
Swift

public static let reservedValueOfTag: String
Show on GitHub
Identifier
Undocumented
Declaration
Swift

public typealias Identifier = String
Show on GitHub
ID
The client identifier.
Declaration
Swift

public let ID: IMClient.Identifier
Show on GitHub
tag
The client tag.
Declaration
Swift

public let tag: String?
Show on GitHub


                    
                    
                    user

The user.

Declaration

Swift

public private(set) var user: LCUser? { get }

Show on GitHub

options
The client options.
Declaration
Swift

public let options: Options
Show on GitHub
application
The application that the client belongs to.
Declaration
Swift

public let application: LCApplication
Show on GitHub
delegate
The client delegate.
Declaration
Swift

public weak var delegate: IMClientDelegate?
Show on GitHub
signatureDelegate
The signature delegate.
Declaration
Swift

public weak var signatureDelegate: IMSignatureDelegate?
Show on GitHub
eventQueue
The dispatch queue where the event about IM are called. Default is main.
Declaration
Swift

public let eventQueue: DispatchQueue
Show on GitHub
SessionState
The session state of the client.
- opened: opened.
- resuming: resuming.
- paused: paused.
- closing: closing.
- closed: closed.
See more
Declaration
Swift

public enum SessionState
Show on GitHub
sessionState
The current session state of the client.
Declaration
Swift

public private(set) var sessionState: SessionState { get set }
Show on GitHub
Options
Options that can modify behaviors of client.
See more
Declaration
Swift

public struct Options : OptionSet
Show on GitHub

Init


                    
                    
                    init(application:ID:tag:options:delegate:signatureDelegate:eventQueue:)

Initialization.

Throws

Error.

Declaration

Swift

public init(
    application: LCApplication = LCApplication.default,
    ID: IMClient.Identifier,
    tag: String? = nil,
    options: Options = .default,
    delegate: IMClientDelegate? = nil,
    signatureDelegate: IMSignatureDelegate? = nil,
    eventQueue: DispatchQueue = .main)
    throws

Parameters

`ID`	The client identifier. Length should in range `lengthRangeOfClientID`.
`tag`	The client tag. `reservedValueOfTag` should not be used.
`options`	@see `IMClient.Options`.
`delegate`	@see `IMClientDelegate`.
`eventQueue`	@see property `eventQueue`, default is main.
`application`	The application that the client belongs to.

Show on GitHub


                    
                    
                    init(user:tag:options:delegate:signatureDelegate:eventQueue:)

Initialization.

Throws

Error.

Declaration

Swift

public convenience init(
    user: LCUser,
    tag: String? = nil,
    options: Options = .default,
    delegate: IMClientDelegate? = nil,
    signatureDelegate: IMSignatureDelegate? = nil,
    eventQueue: DispatchQueue = .main)
    throws

Parameters

`user`	The user which is valid.
`tag`	The client tag. `reservedValueOfTag` should not be used.
`options`	@see `IMClient.Options`.
`delegate`	@see `IMClientDelegate`.
`eventQueue`	@see property `eventQueue`, default is main.

Show on GitHub

Open & Close

SessionOpenOptions
Options that can modify behaviors of session open operation.
See more
Declaration
Swift

public struct SessionOpenOptions : OptionSet
Show on GitHub


                    
                    
                    open(options:completion:)

Open session.

Declaration

Swift

public func open(
    options: SessionOpenOptions = .default,
    completion: @escaping (LCBooleanResult) -> Void)

Parameters

`options`	@see `IMClient.SessionOpenOptions`, default is `.default`, empty options equal to `[.reconnect]`.
`completion`	Result callback.

Show on GitHub


                    
                    
                    close(completion:)

Close session.

Declaration

Swift

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

Parameters


                                completion

Result callback.

Show on GitHub

Create Conversation


                    
                    
                    createConversation(clientIDs:name:attributes:isUnique:completion:)

Create a Normal Conversation. Default is a Normal Unique Conversation.

Declaration

Swift

public func createConversation(
    clientIDs: Set<String>,
    name: String? = nil,
    attributes: [String: Any]? = nil,
    isUnique: Bool = true,
    completion: @escaping (LCGenericResult<IMConversation>) -> Void)
    throws

Parameters

`clientIDs`	The set of client ID. it’s the members of the conversation which will be created. the initialized members always contains current client’s ID. if the created conversation is unique, and server has one unique conversation with the same members, that unique conversation will be returned.
`name`	The name of the conversation.
`attributes`	The attributes of the conversation.
`isUnique`	True means create or get a unique conversation, default is true.
`completion`	Result callback.

Show on GitHub


                    
                    
                    createChatRoom(name:attributes:completion:)

Create a Chat Room.

Declaration

Swift

public func createChatRoom(
    name: String? = nil,
    attributes: [String: Any]? = nil,
    completion: @escaping (LCGenericResult<IMChatRoom>) -> Void)
    throws

Parameters

`name`	The name of the chat room.
`attributes`	The attributes of the chat room.
`completion`	Result callback.

Show on GitHub


                    
                    
                    createTemporaryConversation(clientIDs:timeToLive:completion:)

Create a Temporary Conversation. Temporary Conversation is unique in it’s Life Cycle.

Declaration

Swift

public func createTemporaryConversation(
    clientIDs: Set<String>,
    timeToLive: Int32,
    completion: @escaping (LCGenericResult<IMTemporaryConversation>) -> Void)
    throws

Parameters

`clientIDs`	The set of client ID. it’s the members of the conversation which will be created. the initialized members always contains this client’s ID.
`timeToLive`	The time interval for the life of the temporary conversation.
`completion`	Result callback.

Show on GitHub

Conversation Query

conversationQuery
Create a new conversation query.
Declaration
Swift

public var conversationQuery: IMConversationQuery { get }
Show on GitHub

Conversation Memory Cache


                    
                    
                    getCachedConversation(ID:completion:)

Get conversation instance from memory cache.

Declaration

Swift

public func getCachedConversation(ID: String, completion: @escaping (LCGenericResult<IMConversation>) -> Void)

Parameters

`ID`	The ID of the conversation.
`completion`	callback.

Show on GitHub


                    
                    
                    removeCachedConversation(IDs:all:completion:)

Remove conversation instance from memory cache.

Declaration

Swift

public func removeCachedConversation(
    IDs: Set<String>? = nil,
    all: Bool? = nil,
    completion: @escaping (LCBooleanResult) -> Void)

Parameters

`IDs`	The set of the conversation ID.
`all`	If this parameter set to `true`, then will remove all conversation instance from memory cache.
`completion`	callback.

Show on GitHub

Session Query


                    
                    
                    queryOnlineClients(clientIDs:completion:)

Query online state of clients, the ID in the result set means online.

Declaration

Swift

public func queryOnlineClients(clientIDs: Set<String>, completion: @escaping (LCGenericResult<Set<String>>) -> Void) throws

Parameters

`clientIDs`	The set of ID to be queried, count of IDs should in range 1…20.
`completion`	callback.

Show on GitHub

Local Storage


                    
                    
                    prepareLocalStorage(completion:)

Open database of the local storage.

Throws

If client not init with usingLocalStorage, then throws error.

Declaration

Swift

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

Parameters


                                completion

Result of callback

Show on GitHub

StoredConversationOrder
Query Order Option for stored conversations.
- updatedTimestamp: By updated timestamp.
- createdTimestamp: By created timestamp.
- lastMessageSentTimestamp: By last message sent timestamp.
See more
Declaration
Swift

public enum StoredConversationOrder
Show on GitHub


                    
                    
                    getAndLoadStoredConversations(order:completion:)

Get stored conversations and load them to memory container.

Throws

If client not init with usingLocalStorage, then throws error.

Declaration

Swift

public func getAndLoadStoredConversations(
    order: IMClient.StoredConversationOrder = .lastMessageSentTimestamp(descending: true),
    completion: @escaping (LCGenericResult<[IMConversation]>) -> Void)
    throws

Parameters

`order`	@see `IMClient.StoredConversationOrder`.
`completion`	Result of callback.

Show on GitHub


                    
                    
                    deleteStoredConversationAndMessages(IDs:completion:)

Delete the stored conversations and the messages belong to them.

Throws

If client not init with usingLocalStorage, then throws error.

Declaration

Swift

public func deleteStoredConversationAndMessages(
    IDs: Set<String>,
    completion: @escaping (LCBooleanResult) -> Void)
    throws

Parameters

`IDs`	The ID set of the conversations that will be deleted.
`completion`	Result of callback.

Show on GitHub

Session


                    
                    
                    newSessionCommand(op:token:signature:isReopen:)

Undocumented

Declaration

Swift

func newSessionCommand(
    op: IMOpType = .open,
    token: String? = nil,
    signature: IMSignature? = nil,
    isReopen: Bool? = nil)
    -> IMGenericCommand

Show on GitHub