NXMConversation
Objective-C
@interface NXMConversation : NSObject
Swift
class NXMConversation : NSObject
The NXMConversation object represent a conversation.
See
NXMConversation can be used for messaging and media.-
Conversation unique identifier.
Declaration
Objective-C
@property (nonatomic, readonly, nonnull) NSString *uuid;
Swift
var uuid: String { get }
-
Conversation unique name.
Declaration
Objective-C
@property (nonatomic, readonly, nonnull) NSString *name;
Swift
var name: String { get }
-
Conversation display name.
Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSString *displayName;
Swift
var displayName: String? { get }
-
ID of the last event on the conversation.
Declaration
Objective-C
@property (nonatomic, readonly) NSInteger lastEventId;
Swift
var lastEventId: Int { get }
-
Conversation creation date.
Declaration
Objective-C
@property (nonatomic, readonly, nonnull) NSDate *creationDate;
Swift
var creationDate: Date { get }
-
Conversation events delegate.
Declaration
Objective-C
@property (nonatomic, weak, nullable) id<NXMConversationDelegate> delegate;
Swift
weak var delegate: NXMConversationDelegate? { get set }
-
Invite a user as a member of the conversation with a username.
Declaration
Objective-C
- (void)inviteMemberWithUsername:(nonnull NSString *)username completion: (void (^_Nullable)(NSError *_Nullable))completion;
Swift
func inviteMember(withUsername username: String, completion: ((Error?) -> Void)? = nil)
Parameters
username
The username of the user to invite.
completion
A block with param NSError if one occurred.
-
Join the current user as a member of the conversation.
Declaration
Objective-C
- (void)join:(void (^_Nullable)(NSError *_Nullable, NSString *_Nullable))completion;
Swift
func join(_ completion: ((Error?, String?) -> Void)? = nil)
Parameters
completion
A block with two params an NSError if one occurred and NXMMember.
-
Join a specific user as a member of the conversation.
Declaration
Objective-C
- (void)joinMemberWithUsername:(nonnull NSString *)username completion: (void (^_Nullable)(NSError *_Nullable, NSString *_Nullable))completion;
Swift
func joinMember(withUsername username: String, completion: ((Error?, String?) -> Void)? = nil)
Parameters
username
The username of the user to join the conversation.
completion
A block with two params NSError if one occurred and NXMMember.
-
Get a specific member of the conversation.
Declaration
Objective-C
- (void)getMemberWithMemberUuid:(nonnull NSString *)memberId completion: (void (^_Nullable)(NSError *_Nullable, NXMMember *_Nullable))completion;
Swift
func getMemberWithMemberUuid(_ memberId: String, completion: ((Error?, NXMMember?) -> Void)? = nil)
Parameters
memberId
The id of the member to fetch.
completion
A block with two params NSError if one occurred and NXMMember.
-
Get conversation members page.
Declaration
Objective-C
- (void)getMembersPageWithPageSize:(NSUInteger)size order:(NXMPageOrder)order completion: (void (^_Nullable)( NSError *_Nullable, NXMMembersSummaryPage *_Nullable))completion;
Swift
func getMembersPage(withPageSize size: UInt, order: NXMPageOrder, completion: ((Error?, NXMMembersSummaryPage?) -> Void)? = nil)
Parameters
size
The page size.
order
The page order as an
NXMPageOrder
.completion
A completion block with an error object if one occurred.
-
Leaves the conversation.
Declaration
Objective-C
- (void)leave:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func leave(_ completionHandler: ((Error?) -> Void)? = nil)
Parameters
completionHandler
A completion block with an error object if one occurred.
-
Kicks a member from participating in the conversation.
Declaration
Objective-C
- (void)kickMemberWithMemberId:(nonnull NSString *)memberId completion: (void (^_Nullable)(NSError *_Nullable))completion;
Swift
func kickMember(withMemberId memberId: String, completion: ((Error?) -> Void)? = nil)
Parameters
memberId
The id of the member to kick.
completion
A completion block with an error object if one occurred.
-
Mute the current user member.
Declaration
Objective-C
- (void)mute;
Swift
func mute()
-
Unmute the current user member.
Declaration
Objective-C
- (void)unmute;
Swift
func unmute()
-
Enable media for the current user member.
Declaration
Objective-C
- (void)enableMedia;
Swift
func enableMedia()
-
Trigger a media reconnection.
Declaration
Objective-C
- (void)reconnectMedia;
Swift
func reconnectMedia()
-
Disable media for the current user member.
Declaration
Objective-C
- (void)disableMedia;
Swift
func disableMedia()
-
Send a custom event in the conversation.
Declaration
Objective-C
- (void)sendCustomWithEvent:(nonnull NSString *)customType data:(nonnull NSDictionary *)data completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func sendCustom(withEvent customType: String, data: [AnyHashable : Any], completionHandler: ((Error?) -> Void)? = nil)
Parameters
customType
The customType name.
data
The custom event data.
completionHandler
A completion block with an error object if one occurred.
-
Deprecated
Use [NXMConversation sendMessage:completionHandler:] instead.
Sends a text message to the members of the conversation.
Declaration
Objective-C
- (void)sendText:(nonnull NSString *)text completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func sendText(_ text: String, completionHandler: ((Error?) -> Void)? = nil)
Parameters
text
The text to send.
completionHandler
A completion block with an error object if one occurred.
-
Deprecated
Use [NXMClient uploadAttachmentWithType:name:data:completionHandler:] and [NXMConversation sendMessage:completionHandler:] instead.
Sends an attachment message to the members of the conversation.
Declaration
Objective-C
- (void)sendAttachmentWithType:(NXMAttachmentType)type name:(nonnull NSString *)name data:(nonnull NSData *)data completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func sendAttachment(with type: NXMAttachmentType, name: String, data: Data, completionHandler: ((Error?) -> Void)? = nil)
Parameters
type
The type of the attachment following NXMAttachmentType enum.
name
A name identifier of the attachment.
data
The data of the attachment in a NSData representation.
completionHandler
A completion block with an error object if one occurred.
-
Sends a message event to the members of the conversation.
Declaration
Objective-C
- (void)sendMessage:(nonnull NXMMessage *)message completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func sendMessage(_ message: NXMMessage, completionHandler: ((Error?) -> Void)? = nil)
Parameters
message
The message to send.
completionHandler
A completion block with an error object if one occurred.
-
Sends an indication that the message has been delivered to the current user’s member.
Declaration
Objective-C
- (void)sendMarkDeliveredMessage:(NSInteger)messageId completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func sendMarkDeliveredMessage(_ messageId: Int, completionHandler: ((Error?) -> Void)? = nil)
Parameters
messageId
The message identifier of the message that has been delivered to the current user.
completionHandler
A completion block with an error object if one occurred.
-
Sends an indication that the current user’s member has seen a message.
Declaration
Objective-C
- (void)sendMarkSeenMessage:(NSInteger)messageId completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func sendMarkSeenMessage(_ messageId: Int, completionHandler: ((Error?) -> Void)? = nil)
Parameters
messageId
The message identifier of the message that has been seen by the current user.
completionHandler
A completion block with an error object if one occurred.
-
Sends an indication that the current user’s member started typing.
Declaration
Objective-C
- (void)sendStartTyping: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func sendStartTyping(_ completionHandler: ((Error?) -> Void)? = nil)
Parameters
completionHandler
A completion block with an error object if one occurred.
-
Sends an indication that the current user’s member stopped typing.
Declaration
Objective-C
- (void)sendStopTyping:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func sendStopTyping(_ completionHandler: ((Error?) -> Void)? = nil)
Parameters
completionHandler
A completion block with an error object if one occurred.
-
Get conversation events page with 10 elements page size and ascending order.
Declaration
Objective-C
- (void)getEventsPage: (void (^_Nullable)(NSError *_Nullable, NXMEventsPage *_Nullable))completionHandler;
Swift
func getEventsPage(_ completionHandler: ((Error?, NXMEventsPage?) -> Void)? = nil)
Parameters
completionHandler
A completion block with an error object if one occurred.
-
Get conversation events page.
Declaration
Objective-C
- (void)getEventsPageWithSize:(NSUInteger)size order:(NXMPageOrder)order completionHandler: (void (^_Nullable)(NSError *_Nullable, NXMEventsPage *_Nullable))completionHandler;
Swift
func getEventsPage(withSize size: UInt, order: NXMPageOrder, completionHandler: ((Error?, NXMEventsPage?) -> Void)? = nil)
Parameters
size
The page size.
order
The page order as an
NXMPageOrder
.completionHandler
A completion block with an error object if one occurred.
-
Get conversation events page.
Declaration
Objective-C
- (void)getEventsPageWithSize:(NSUInteger)size order:(NXMPageOrder)order eventType:(nullable NSString *)eventType completionHandler: (void (^_Nullable)(NSError *_Nullable, NXMEventsPage *_Nullable))completionHandler;
Swift
func getEventsPage(withSize size: UInt, order: NXMPageOrder, eventType: String?, completionHandler: ((Error?, NXMEventsPage?) -> Void)? = nil)
Parameters
size
The page size.
order
The page order as an
NXMPageOrder
.eventType
The event type filter.
completionHandler
A completion block with an error object if one occurred.