IMConversationQuery Class Reference

limitRangeOfQueryResult
limit of conversation ID’s count in one query.
Declaration
Swift

public static let limitRangeOfQueryResult: ClosedRange<Int>
Show on GitHub
Options
conversation query option.
See more
Declaration
Swift

public struct Options : OptionSet
Show on GitHub
options
@see Options, default is nil.
Declaration
Swift

public var options: Options?
Show on GitHub
client
the client which this query belong to.
Declaration
Swift

public private(set) weak var client: IMClient? { get }
Show on GitHub

Combine


                    
                    
                    and(_:)

Performs a logical AND operation on an array of one or more expressions of query.

Throws

LCError

Declaration

Swift

public static func and(_ queries: [IMConversationQuery]) throws -> IMConversationQuery?

Parameters


                                queries

An array of one or more expressions of query.

Return Value

An optional IMConversationQuery

Show on GitHub


                    
                    
                    and(_:)

Performs a logical AND operation on self and the query.

Throws

LCError

Declaration

Swift

public func and(_ query: IMConversationQuery) throws -> IMConversationQuery?

Parameters


                                query

The query.

Return Value

An optional IMConversationQuery

Show on GitHub


                    
                    
                    or(_:)

Performs a logical OR operation on an array of one or more expressions of query.

Throws

LCError

Declaration

Swift

public static func or(_ queries: [IMConversationQuery]) throws -> IMConversationQuery?

Parameters


                                queries

An array of one or more expressions of query.

Return Value

An optional IMConversationQuery

Show on GitHub


                    
                    
                    or(_:)

Performs a logical OR operation on self and the query.

Throws

LCError

Declaration

Swift

public func or(_ query: IMConversationQuery) throws -> IMConversationQuery?

Parameters


                                query

The query.

Return Value

An optional IMConversationQuery

Show on GitHub

Where


                    
                    
                    where(_:_:)

Declaration

Swift

public override func `where`(_ key: String, _ constraint: Constraint) throws

Show on GitHub

Find


                    
                    
                    getConversation(by:completion:)

Get Conversation by ID.

Declaration

Swift

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

Parameters

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

Show on GitHub


                    
                    
                    getConversations(by:completion:)

Get Conversations by ID set.

Declaration

Swift

public func getConversations(
    by IDs: Set<String>,
    completion: @escaping (LCGenericResult<[IMConversation]>) -> Void)
    throws

Parameters

`IDs`	The set of ID string.
`completion`	callback.

Show on GitHub


                    
                    
                    getTemporaryConversation(by:completion:)

Get Temporary Conversation by ID.

Declaration

Swift

public func getTemporaryConversation(
    by ID: String,
    completion: @escaping (LCGenericResult<IMTemporaryConversation>) -> Void)
    throws

Parameters

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

Show on GitHub


                    
                    
                    getTemporaryConversations(by:completion:)

Get Temporary Conversations by ID set.

Declaration

Swift

public func getTemporaryConversations(
    by IDs: Set<String>,
    completion: @escaping (LCGenericResult<[IMTemporaryConversation]>) -> Void)
    throws

Parameters

`IDs`	The set of ID string.
`completion`	callback.

Show on GitHub


                    
                    
                    findConversations(completion:)

General conversation query (not support temporary conversation query).

The default where constraint is {“m”: client.ID}, The default sort is -lm, The default limit is 10, The default skip is 0.

Declaration

Swift

public func findConversations(completion: @escaping (LCGenericResult<[IMConversation]>) -> Void) throws

Parameters


                                completion

callback

Show on GitHub

Unavailable


                    
                    
                    get(_:cachePolicy:completionQueue:completion:)

Declaration

Swift

public override func get<T>(_ objectId: LCStringConvertible, cachePolicy: LCQuery.CachePolicy = .onlyNetwork, completionQueue: DispatchQueue = .main, completion: @escaping (LCValueResult<T>) -> Void) -> LCRequest where T : LCObject

Show on GitHub


                    
                    
                    getFirst(cachePolicy:completionQueue:completion:)

Declaration

Swift

public override func getFirst<T>(cachePolicy: LCQuery.CachePolicy = .onlyNetwork, completionQueue: DispatchQueue = .main, completion: @escaping (LCValueResult<T>) -> Void) -> LCRequest where T : LCObject

Show on GitHub


                    
                    
                    count(cachePolicy:completionQueue:completion:)

Declaration

Swift

public override func count(cachePolicy: LCQuery.CachePolicy = .onlyNetwork, completionQueue: DispatchQueue = .main, completion: @escaping (LCCountResult) -> Void) -> LCRequest

Show on GitHub