Bold360 and BoldChat Developer Center

BCMessage Class Reference

The container class for all information about a specific chat message. More...

#import <BCMessage.h>

Inheritance diagram for BCMessage:

Instance Methods

(id) - initWithID:sender:created:updated:htmlText:
 Constructor for a chat message instance. More...
 

Class Methods

(id) + messageWithID:sender:created:updated:htmlText:
 The static constructor for a chat message instance. More...
 

Properties

NSString * ID
 The unique ID of the message. More...
 
BCPersonsender
 The details of the sender of the message. More...
 
NSDate * created
 The creation time of the message. More...
 
NSDate * updated
 The last update time of the message. More...
 
NSString * htmlText
 The message text formatted in html. More...
 

Detailed Description

The container class for all information about a specific chat message.

Since
Version 1.0

Method Documentation

- (id) initWithID: (NSString *)  ID
sender: (BCPerson *)  sender
created: (NSDate *)  created
updated: (NSDate *)  updated
htmlText: (NSString *)  htmlText 

Constructor for a chat message instance.

Parameters
IDThe ID of the message. It is autogenerated if not set.
senderThe sender person.
createdCreation time.
updatedLast update time.
htmlTextThe message text in html.
Returns
An instance of BCMessage.
Since
Version 1.0
+ (id) messageWithID: (NSString *)  ID
sender: (BCPerson *)  sender
created: (NSDate *)  created
updated: (NSDate *)  updated
htmlText: (NSString *)  htmlText 

The static constructor for a chat message instance.

Parameters
IDThe ID of the message. It is autogenerated if not set.
senderThe sender person.
createdCreation time.
updatedLast update time.
htmlTextThe message text in html.
Returns
An instance of BCMessage.
Since
Version 1.0

Property Documentation

- (NSDate*) created
readnonatomiccopy

The creation time of the message.

Since
Version 1.0
- (NSString*) htmlText
readnonatomiccopy

The message text formatted in html.

Since
Version 1.0
- (NSString*) ID
readnonatomiccopy

The unique ID of the message.

Since
Version 1.0
- (BCPerson*) sender
readwritenonatomicstrong

The details of the sender of the message.

Since
Version 1.0
- (NSDate*) updated
readnonatomiccopy

The last update time of the message.

Since
Version 1.0

The documentation for this class was generated from the following file: