Conversation

open class Conversation : Observable<ConversationEvent>

extension Conversation: Equatable

Represents conversation N-N communication context


                    
                    
                    cloudPublicId

Undocumented

Declaration

Swift

open internal(set) var cloudPublicId: String? { get }


                    
                    
                    instanceId

Undocumented

Declaration

Swift

open internal(set) var instanceId: String? { get }


                    
                    
                    accessType

Declaration

Swift

open internal(set) var accessType: ConversationAccessType! { get }


                    
                    
                    status

Declaration

Swift

open internal(set) var status: ConversationStatus! { get }


                    
                    
                    access

Declaration

Swift

open internal(set) var access: ConversationAccess? { get }


                    
                    
                    role

Local user conversation related role

Declaration

Swift

open internal(set) var role: ConversationUserRole? { get }


                    
                    
                    friendlyName

Declaration

Swift

open internal(set) var friendlyName: String? { get }

moderatorId
Conversation’s moderator user id
Declaration
Swift

open internal(set) var moderatorId: String? { get }
Err
Undocumented
See more
Declaration
Swift

public enum Err : SDKError
join(completion:)
Joins a conversation. Once in the conversation the user will be able to see other contacts inside it, send and receive messages, publish and subscribe to streams
Declaration
Swift

open func join(completion: @escaping (_ error: Error?, _ accessAllowed: Bool) -> Void)
cancelJoin()
Cancel joining process
Declaration
Swift

open func cancelJoin()
leave(completion:)
Leaves conversation. The user will automatically stop publishing its streams to the conversation and stop subscribing to any events from the conversation.
Declaration
Swift

open func leave(completion: @escaping (() -> Void))


                    
                    
                    sendInvitation(contact:completion:)

Invites Contact to the conversation

Declaration

Swift

open func sendInvitation(contact: Contact, completion: @escaping (_ invitation: SentInvitation?) -> Void)


                    
                    
                    sendMessage(message:file:completion:)

Undocumented

Declaration

Swift

open func sendMessage(message: String, file: FileInfo? = nil, completion: @escaping (_ error: Error?, _ message: ChatMessage?) -> Void)

publish(stream:completion:)
Publish stream to conversation The stream will be able to be subscribed by other contacts within the conversation
Declaration
Swift

open func publish(stream: Stream, completion: @escaping (_ error: Error?, _ stream: Stream?) -> Void)
unpublishStreamWithId(_:completion:)
Unpublishes currently published stream to conversation
Declaration
Swift

open func unpublishStreamWithId(_ streamId: String, completion: (() -> Void)? = nil)
subscribeToStream(streamId:)
Subscribes to a stream. The subscription will automatically stop if the contact publishing the stream unpublishes it. The ConversationEvent.streamAdded(_:) event will be fired when the stream becomes available. The ConversationEvent.streamRemoved(_:) event will be fired when the stream is no longer available.
Declaration
Swift

open func subscribeToStream(streamId: String)
unsubscribeFromStreamWithId(_:completion:)
Unsubscribes from a conversation’s stream
Declaration
Swift

open func unsubscribeFromStreamWithId(_ streamId: String, completion: (() -> Void)? = nil)
getAvailableStreamList()
Declaration
Swift

open func getAvailableStreamList() -> [StreamInfo]?
Return Value

Information for media streams available in the conversation
getStreamForConversationCall(callId:)
Gets a stream using ConversationCall.id
Declaration
Swift

open func getStreamForConversationCall(callId: String) -> Stream?
getPublishedStreams()
Declaration
Swift

open func getPublishedStreams() -> [Stream]?
Return Value

Published streams list
getSubscribedStreams()
Declaration
Swift

open func getSubscribedStreams() -> [Stream]?
Return Value

Subscribed streams list


                    
                    
                    getStream(streamId:)

Declaration

Swift

open func getStream(streamId: String) -> Stream?

getModerator()
Declaration
Swift

open func getModerator() -> Contact?
Return Value

Conversation moderator Contact
getContacts()
Declaration
Swift

open func getContacts() -> [Contact]?
Return Value

Contacts list within the conversation
getName()
Declaration
Swift

open func getName() -> String
Return Value

Conversation name
getConversationCall(_:)
Declaration
Swift

open func getConversationCall(_ streamId: String) -> ConversationCall?
Return Value

ConversationCall using Stream.id
isJoined()
Checks if the conversation is joined
Declaration
Swift

open func isJoined() -> Bool

Whiteboard


                    
                    
                    startWhiteboardSession(completion:)

Starts new whiteboard session

Declaration

Swift

open func startWhiteboardSession(completion: @escaping (_ error: Error?, _ client: WhiteboardClient?) -> Void)

stopWhiteboardSession()
Stops whiteboard session
Declaration
Swift

open func stopWhiteboardSession()
uploadMedia(media:completion:)
Uploads media Currently limited to .jpeg only Use Conversation.pushData to upload other data types
Declaration
Swift

open func uploadMedia(media: Data, completion: @escaping (_ error: Error?, _ media: CloudMediaInfo?) -> Void)


                    
                    
                    fetchMediaList(options:completion:)

Fetch conversation media list from the cloud

Declaration

Swift

open func fetchMediaList(options: [String : Any?]? = nil, completion: @escaping ((_ error: Error?, _ medias: [Media]?) -> Void))


                    
                    
                    pushData(descriptor:completion:)

Pushes arbitrary data using data channel Limited by 50MB

Declaration

Swift

open func pushData(descriptor: PushBufferDataDescriptor, completion: @escaping (_ error: Error?, _ info: CloudMediaInfo?) -> Void)


                    
                    
                    cancelPushData(id:completion:)

Undocumented

Declaration

Swift

open func cancelPushData(id: String, completion: @escaping () -> Void)

sendRawData(data:)
Send raw data json message to conversation contacts Use Conversation.pushData to upload data of large amounts
Declaration
Swift

open func sendRawData(data: [String : Any])

Helpers

typeOfName(_:)
Throws
Conversation.Err if the name is not valid
Declaration
Swift

open class func typeOfName(_ name: String) throws -> ConversationAccessType
Return Value

ConversationAccessType using conversation name
isNameValid(_:)
Declaration
Swift

open class func isNameValid(_ id: String) -> Bool
Return Value

Name check result


                    
                    
                    onEvent(_:_:)

Undocumented

Declaration

Swift

open override func onEvent(_ observer: AnyObject, _ callback: @escaping ((ConversationEvent) -> Void))


                    
                    
                    ==(_:_:)

Declaration

Swift

public static func == (lhs: Conversation, rhs: Conversation) -> Bool

Conversation

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Return Value

Declaration

Declaration

Return Value

Declaration

Return Value

Declaration

Declaration

Return Value

Declaration

Return Value

Declaration

Return Value

Declaration

Return Value

Declaration

Whiteboard

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Helpers

Declaration

Return Value

Declaration

Return Value

Declaration

Declaration