ACLIPMessage Class Reference

Inherits from NSManagedObject
Declared in ACLIPMessage.h

Overview

An ACLIPMessage encapulates the data of a message.

  guid

Unique identifier for the message

var guid: String! { get }
@property (nonatomic, readonly) NSString *guid

Discussion

Unique identifier for the message

Declared In

ACLIPMessage.h

  title

The title of the message

var title: String! { get }
@property (nonatomic, readonly) NSString *title

Discussion

The title of the message

Declared In

ACLIPMessage.h

  messageText

The descriptive text associated with this message

var messageText: String! { get }
@property (nonatomic, readonly) NSString *messageText

Discussion

The descriptive text associated with this message

Declared In

ACLIPMessage.h

  sender

The user who sent the message

var sender: ACLIPUser! { get }
@property (nonatomic, readonly) ACLIPUser *sender

Discussion

The user who sent the message

Declared In

ACLIPMessage.h

  recipients

The recipients of the message

var recipients: Set<NSObject>! { get }
@property (nonatomic, readonly) NSSet *recipients

Discussion

The recipients of the message

Declared In

ACLIPMessage.h

  statuses

The statuses for the message

var statuses: Set<NSObject>! { get }
@property (nonatomic, readonly) NSSet *statuses

Discussion

The statuses for the message

Declared In

ACLIPMessage.h

  video

The message’s video

var video: ACLIPVideo! { get }
@property (nonatomic, readonly) ACLIPVideo *video

Discussion

The message’s video

Declared In

ACLIPMessage.h

  createdDate

The date the video was sent

var createdDate: NSDate! { get }
@property (nonatomic, readonly) NSDate *createdDate

Discussion

The date the video was sent

Declared In

ACLIPMessage.h

  messageThread

The message thread that the message belongs to

var messageThread: ACLIPMessageThread! { get }
@property (nonatomic, readonly) ACLIPMessageThread *messageThread

Discussion

The message thread that the message belongs to

Declared In

ACLIPMessage.h

  read

Has the message been read by the current user.

var read: Bool { get }
@property (nonatomic, readonly, getter=isRead) BOOL read

Discussion

Has the message been read by the current user.

Declared In

ACLIPMessage.h

  yanked

Has the message been yanked by the sender.

var yanked: Bool { get }
@property (nonatomic, readonly, getter=isYanked) BOOL yanked

Discussion

Has the message been yanked by the sender.

Declared In

ACLIPMessage.h

+ messageForGUID:

Returns a message for the guid

func messageForGUID(_ guid: String) -> ACLIPMessage
+ (ACLIPMessage *)messageForGUID:(NSString *)guid

Parameters

guid

A string of message guid.

Return Value

An ACLIPMessage object

Discussion

Returns a message for the guid

Returns the ACLIPMessage objects for guid.

Declared In

ACLIPMessage.h

+ messagesForGUIDs:

Returns messages for the guids

class func messagesForGUIDs(_ guids: [AnyObject]) -> [AnyObject]!
+ (NSArray *):(NSArray *)guids

Parameters

guids

An array of message guids.

Return Value

An array of ACLIPMessage objects

Discussion

Returns messages for the guids

Returns the ACLIPMessage objects for guids.

Declared In

ACLIPMessage.h

– deleteMessageCompleteBlock:errorBlock:

Deletes the message.

func deleteMessageCompleteBlock(_ completedBlock: ACLIPNetworkCompleteBlock!, errorBlock errorBlock: ACLIPNetworkErrorBlock!)
- (void)deleteMessageCompleteBlock:(ACLIPNetworkCompleteBlock)completedBlock errorBlock:(ACLIPNetworkErrorBlock)errorBlock

Parameters

completedBlock

A block that gets called upon successfully loading the messages list. The completeBlock may be called more then once if cached results exist. completedBlock can be nil.

errorBlock

A block that gets called when any error occurs. The error can be either a Foundation network error or an ACLIPNetworkReturnType error. errorBlock can be nil in no error handling is requiried.

Discussion

Deletes the message.

The call deletes the message from the user’s message list.

Declared In

ACLIPMessage.h

– markMessageReadCompleteBlock:errorBlock:

Marks the message as being read by the user.

func markMessageReadCompleteBlock(_ completedBlock: ACLIPNetworkCompleteBlock!, errorBlock errorBlock: ACLIPNetworkErrorBlock!)
- (void)markMessageReadCompleteBlock:(ACLIPNetworkCompleteBlock)completedBlock errorBlock:(ACLIPNetworkErrorBlock)errorBlock

Parameters

completedBlock

A block that gets called upon successfully marking the message read. completedBlock can be nil.

errorBlock

A block that gets called when any error occurs. The error can be either a Foundation network error or an ACLIPNetworkReturnType error. errorBlock can be nil in no error handling is requiried.

Discussion

Marks the message as being read by the user.

Declared In

ACLIPMessage.h

– markMessageUnreadCompleteBlock:errorBlock:

Marks the message as unread by the user.

func markMessageUnreadCompleteBlock(_ completedBlock: ACLIPNetworkCompleteBlock!, errorBlock errorBlock: ACLIPNetworkErrorBlock!)
- (void)markMessageUnreadCompleteBlock:(ACLIPNetworkCompleteBlock)completedBlock errorBlock:(ACLIPNetworkErrorBlock)errorBlock

Parameters

completedBlock

A block that gets called upon successfully marking the message unread. completedBlock can be nil.

errorBlock

A block that gets called when any error occurs. The error can be either a Foundation network error or an ACLIPNetworkReturnType error. errorBlock can be nil in no error handling is requiried.

Discussion

Marks the message as unread by the user.

Declared In

ACLIPMessage.h

– yankMessageForRecipients:completeBlock:errorBlock:

Removes the message from being able to be seen by the recipients.

func yankMessageForRecipients(_ recipients: [AnyObject]!, completeBlock completedBlock: ACLIPNetworkCompleteBlock!, errorBlock errorBlocik: ACLIPNetworkErrorBlock!)
- (void)yankMessageForRecipients:(NSArray *)recipients completeBlock:(ACLIPNetworkCompleteBlock)completedBlock errorBlock:(ACLIPNetworkErrorBlock)errorBlock

Parameters

recipients

An array of recipient user IDs. The array must contain at least one user ID.

completedBlock

A block that gets called upon successfully loading the messages list. The completeBlock may be called more then once if cached results exist. completedBlock can be nil.

errorBlock

A block that gets called when any error occurs. The error can be either a Foundation network error or an ACLIPNetworkReturnType error. errorBlock can be nil in no error handling is requiried.

Discussion

Removes the message from being able to be seen by the recipients.

Yanking causes the message to no longer be viewable by the users in the recipients list. It does not delete the message or cause it to not be viewable by people who originally recieved it but are not in the recipients list. Messages can only be yanked by the sender.

Declared In

ACLIPMessage.h

– unyankMessageForRecipients:completeBlock:errorBlock:

Allows the message to be seen by the recipients again.

func unyankMessageForRecipients(_ recipients: [AnyObject]!, completeBlock completedBlock: ACLIPNetworkCompleteBlock!, errorBlock errorBlock: ACLIPNetworkErrorBlock!)
- (void)unyankMessageForRecipients:(NSArray *)recipients completeBlock:(ACLIPNetworkCompleteBlock)completedBlock errorBlock:(ACLIPNetworkErrorBlock)errorBlock

Parameters

recipients

An array of recipient user IDs. The array must contain at least one user ID.

completedBlock

A block that gets called upon successfully loading the messages list. The completeBlock may be called more then once if cached results exist. completedBlock can be nil.

errorBlock

A block that gets called when any error occurs. The error can be either a Foundation network error or an ACLIPNetworkReturnType error. errorBlock can be nil in no error handling is requiried.

Discussion

Allows the message to be seen by the recipients again.

Unyanking causes the message to be viewable again by the users in the recipients list. It will not allow a user in the recipients list to be able to view the message if the user was not a recipient when the message was originally sent. Messages can only be unyanked by the sender.

Declared In

ACLIPMessage.h