QNChatRepository

public class QNChatRepository

Represents a chat

ChatType
Define wether a chat is a group or not
- oneToOne
- groupChat
Declaration
Swift

public enum ChatType

Delegate


                    
                    
                    delegate

Delegate

Declaration

Swift

public weak var delegate: QNChatDelegate? { get set }

Properties

type
Expose chat type (1-1 or group)
Declaration
Swift

public var type: ChatType { get }
identifier
Chat identifier (remote user for 1-1 and UUID for group chats)
Declaration
Swift

public var identifier: String { get }
groupChatActions
Group actions for group chats like invite a participant or expel one
Declaration
Swift

public private(set) var groupChatActions: QNGroupChatActions? { get }


                    
                    
                    lastMessage

Last message received

Declaration

Swift

public fileprivate(set) var lastMessage: QNChatMessage? { get set }


                    
                    
                    unreadMessagesCount

Count of unread messages

Declaration

Swift

public fileprivate(set) var unreadMessagesCount: Int { get set }


                    
                    
                    title

Title of chat

Declaration

Swift

public fileprivate(set) var title: String { get }


                    
                    
                    image

Image of chat

Declaration

Swift

public fileprivate(set) var image: String? { get }


                    
                    
                    imageUrl

Image URL of chat

Declaration

Swift

public fileprivate(set) var imageUrl: URL? { get }

isConferenceChat
Chat is associated with a conference
Declaration
Swift

public var isConferenceChat: Bool { get }

Api


                    
                    
                    fetchMessagesFromStore(messageSearch:completion:)

Fetch history related to this user, messages are received in delegate

Declaration

Swift

public func fetchMessagesFromStore(messageSearch: QNChatMessageSearch,
                                   completion: @escaping ([QNChatMessage]) -> Void)

Parameters

`messageSearch`	search criteria
`completion`	completion block with `QNChatMessageSearchResult`


                    
                    
                    sendParticipantActionInChat(_:)

Send participant action, like typing or active, to remote participant

Declaration

Swift

public func sendParticipantActionInChat(_ action: QNChatMessage.ParticipantAction)

Parameters


                                action

Current participant action


                    
                    
                    send(message:completion:)

Sends a new message to other participant

Declaration

Swift

public func send(message: String,
                 completion: @escaping (Result<QNChatMessage, ResourceError>) -> Void)

Parameters


                                message

Body message to be sent

Return Value

A Message


                    
                    
                    send(file:named:pathToLocalFile:uploadTaskHandler:progressHandler:completion:)

Send a file to Chat

Declaration

Swift

public func send(file: Data,
                 named filename: String,
                 pathToLocalFile: String?,
                 uploadTaskHandler: ((URLSessionUploadTask) -> Void)? = nil,
                 progressHandler: ((Float) -> Void)? = nil,
                 completion: @escaping (Result<QNChatMessage, ResourceError>) -> Void)

Parameters

`file`	Data to send
`named`	Name use to share it
`pathToLocalFile`	File’s path

Return Value

A Message where upload progress is received


                    
                    
                    mark(message:as:)

Mark a message with a new status

Declaration

Swift

public func mark(message: QNChatMessage, as status: QNChatMessage.Status)

Parameters

`message`	Message to change status
`status`	New status

markChatAsRead()
Send a mark with last message read
Declaration
Swift

public func markChatAsRead()


                    
                    
                    archive(completion:)

Archive chat

Declaration

Swift

public func archive(completion: @escaping () -> Void)


                    
                    
                    delete(completion:)

Delete chat

Declaration

Swift

public func delete(completion: @escaping () -> Void)