SippoClient
This section explains how to create a SippoOneToOneChat and use chat actions
First step
Chat session has to be started
// Set delegate before to receive incoming events, if delegate is set after start session some events could be lost
let delegate = ChatsDelegateExample()
let chats = try? SippoClient.client.chats.get()
chats?.delegate = delegate
chats?.startSession {
// Chats actions are available now
}
Create a new OneToOneChat
let chats = try? SippoClient.client.chats.get()
chats?.createOneToOneChat(toUser: "anUser") { result in
switch result {
case let .success(chat):
print("A new chat: \(chat)")
case let .failure(error):
print("Error creating the chat: \(error)")
}
}
Receive new one to one chats
Implement a new ChatsDelegate
class ChatsDelegateExample: ChatsDelegate {
func chats(_ chats: Chats, didReceiveOneToOneChat chat: SippoOneToOneChat, with message: ChatMessage) {
// New OneToOneChat receive
print("New OneToOneChat: \(chat)")
// Message which starts the chat
print("With message: \(message)")
}
}
And set it to Chats
let delegate = ChatsDelegateExample()
try? SippoClient.client.chats.get().delegate = delegate
Send messages
Implement a SippoOneToOneChatDelegate
class OneToOneChatDelegate: SippoOneToOneChatDelegate {
func chat(_ oneToOnechat: SippoOneToOneChat, didReceiveMessage message: ChatMessage) {
}
func chat(_ oneToOnechat: SippoOneToOneChat, didReceiveMesssageFromArchive message: ChatMessage) {
}
func chat(_ oneToOnechat: SippoOneToOneChat, didReceiveMessageStatusUpdate message: ChatStatusMessage) {
}
func chat(_ oneToOneChat: SippoOneToOneChat, didReceiveParticipantAction: ChatMessage.ParticipantAction) {
}
}
Send a text or file message
var aChat: SippoOneToOneChat!
let delegate = OneToOneChatDelegate()
aChat.delegate = delegate
// Text message
let textMessage = aChat.send(message: "This is a message")
// Message status can be checked from:
// func chat(_ oneToOnechat: SippoOneToOneChat, didReceiveMessageStatusUpdate message: ChatStatusMessage) delegate function
print("Trying to send: \(textMessage)")
// File message
let fileMessage = aChat.send(file: Data(), named: "photo.png")
// This callback will be call everytime the upload changes (bytes sent, status...)
fileMessage.fileUploadUpdates { update in
print("Update progress: \(update?.bytesSent)")
}
Mark a message
var aChat: SippoOneToOneChat!
var receivedMessage: ChatMessage
aChat.mark(message: receivedMessage, as: .displayed)
Send participant action
var aChat: SippoOneToOneChat!
aChat.sendParticipantActionInChat(.typing)
Receive messages
Stored messages
var aChat: SippoOneToOneChat!
let delegate = OneToOneChatDelegate()
aChat.delegate = delegate
// Use search to fetch message from history
aChat.fetchMessagesFromStore(messageSearch: ChatMessageSearch(limitTo: 20))
// Receive them from:
// func chat(_ oneToOnechat: SippoOneToOneChat, didReceiveMesssageFromArchive message: ChatMessage) delegate function
Messages from other participant
var aChat: SippoOneToOneChat!
let delegate = OneToOneChatDelegate()
aChat.delegate = delegate
// Receive text or file messages from:
// func chat(_ oneToOnechat: SippoOneToOneChat, didReceiveMessage message: ChatMessage) delegate function
// Receive status messages from:
// func chat(_ oneToOnechat: SippoOneToOneChat, didReceiveMessageStatusUpdate message: ChatStatusMessage)
// Receive participant actions (typing, active) from:
// func chat(_ oneToOneChat: SippoOneToOneChat, didReceiveParticipantAction: ChatMessage.ParticipantAction)