session-ios/SignalServiceKit/src/Messages/Interactions/TSMessage.h

//
//  Copyright (c) 2017 Open Whisper Systems. All rights reserved.
//

#import "TSInteraction.h"

NS_ASSUME_NONNULL_BEGIN

/**
 *  Abstract message class.
 */

@class TSAttachmentPointer;

@interface TSMessage : TSInteraction

@property (nonatomic, readonly) NSMutableArray<NSString *> *attachmentIds;
@property (nonatomic, readonly, nullable) NSString *body;
@property (nonatomic, readonly) uint32_t expiresInSeconds;
@property (nonatomic, readonly) uint64_t expireStartedAt;
@property (nonatomic, readonly) uint64_t expiresAt;
@property (nonatomic, readonly) BOOL isExpiringMessage;

- (instancetype)initWithTimestamp:(uint64_t)timestamp;

- (instancetype)initWithTimestamp:(uint64_t)timestamp inThread:(nullable TSThread *)thread;

- (instancetype)initWithTimestamp:(uint64_t)timestamp
                         inThread:(nullable TSThread *)thread
                      messageBody:(nullable NSString *)body;

- (instancetype)initWithTimestamp:(uint64_t)timestamp
                         inThread:(nullable TSThread *)thread
                      messageBody:(nullable NSString *)body
                    attachmentIds:(NSArray<NSString *> *)attachmentIds;

- (instancetype)initWithTimestamp:(uint64_t)timestamp
                         inThread:(nullable TSThread *)thread
                      messageBody:(nullable NSString *)body
                    attachmentIds:(NSArray<NSString *> *)attachmentIds
                 expiresInSeconds:(uint32_t)expiresInSeconds;

- (instancetype)initWithTimestamp:(uint64_t)timestamp
                         inThread:(nullable TSThread *)thread
                      messageBody:(nullable NSString *)body
                    attachmentIds:(NSArray<NSString *> *)attachmentIds
                 expiresInSeconds:(uint32_t)expiresInSeconds
                  expireStartedAt:(uint64_t)expireStartedAt NS_DESIGNATED_INITIALIZER;

- (nullable instancetype)initWithCoder:(NSCoder *)coder NS_DESIGNATED_INITIALIZER;

- (BOOL)hasAttachments;

- (NSString *)previewTextWithTransaction:(YapDatabaseReadTransaction *)transaction;

- (BOOL)shouldStartExpireTimer;
- (BOOL)shouldStartExpireTimer:(YapDatabaseReadTransaction *)transaction;

#pragma mark - Update With... Methods

- (void)updateWithExpireStartedAt:(uint64_t)expireStartedAt transaction:(YapDatabaseReadWriteTransaction *)transaction;

@end

NS_ASSUME_NONNULL_END
Add “received at” timestamp to all TSMessages so that they may be sorted properly. // FREEBIE 8 years ago			`//`
			`// Copyright (c) 2017 Open Whisper Systems. All rights reserved.`
			`//`
Init Commit 10 years ago
			`#import "TSInteraction.h"`

Some nullability annotations - prefer empty list (null object pattern!) for attachments vs nil - stop passing nil args to init // FREEBIE 9 years ago			`NS_ASSUME_NONNULL_BEGIN`

Init Commit 10 years ago			`/**`
style changes // fix compiler warnings - log errors - forward declare where possible - clang-format - remove inaccurate file headers - include Pods in Example app build target to get SignalServiceKit warnings - Fix those warnings! // FREEBIE 9 years ago			`* Abstract message class.`
Init Commit 10 years ago			`*/`

Explain send failures for text and media messages Motivation ---------- We were often swallowing errors or yielding generic errors when it would be better to provide specific errors. We also didn't create an attachment when attachments failed to send, making it impossible to show the user what was happening with an in-progress or failed attachment. Primary Changes --------------- - Funnel all message sending through MessageSender, and remove message sending from MessagesManager. - Record most recent sending error so we can expose it in the UI - Can resend attachments. - Update message status for attachments, just like text messages - Extracted UploadingService from MessagesManager - Saving attachment stream before uploading gives uniform API for send vs. resend - update status for downloading transcript attachments - TSAttachments have a local id, separate from the server allocated id This allows us to save the attachment before the allocation request. Which is is good because: 1. can show feedback to user faster. 2. allows us to show an error when allocation fails. Code Cleanup ------------ - Replaced a lot of global singleton access with injected dependencies to make for easier testing. - Never save group meta messages. Rather than checking before (hopefully) every save, do it in the save method. - Don't use callbacks for sync code. - Handle errors on writing attachment data - Fix old long broken tests that weren't even running. =( - Removed dead code - Use constants vs define - Port flaky travis fixes from Signal-iOS // FREEBIE 9 years ago			`@class TSAttachmentPointer;`

Init Commit 10 years ago			`@interface TSMessage : TSInteraction`

Clarify message.attachments -> attachmentIds What we previously refered to as attachments are actually just the attachment's id (NSString). This has tripped me up a few too many times. Also, use generics with attachment id's array. // FREEBIE 9 years ago			`@property (nonatomic, readonly) NSMutableArray<NSString > attachmentIds;`
Rework the "update with..." methods to avoid re-saving deleted models. 8 years ago			`@property (nonatomic, readonly, nullable) NSString *body;`
			`@property (nonatomic, readonly) uint32_t expiresInSeconds;`
			`@property (nonatomic, readonly) uint64_t expireStartedAt;`
disappearing messages * Support for disappearing messages * update inbox thread preview when receiving message // FREEBIE 9 years ago			`@property (nonatomic, readonly) uint64_t expiresAt;`
			`@property (nonatomic, readonly) BOOL isExpiringMessage;`
Init Commit 10 years ago
Some nullability annotations - prefer empty list (null object pattern!) for attachments vs nil - stop passing nil args to init // FREEBIE 9 years ago			`- (instancetype)initWithTimestamp:(uint64_t)timestamp;`

			`- (instancetype)initWithTimestamp:(uint64_t)timestamp inThread:(nullable TSThread *)thread;`

Init Commit 10 years ago			`- (instancetype)initWithTimestamp:(uint64_t)timestamp`
Some nullability annotations - prefer empty list (null object pattern!) for attachments vs nil - stop passing nil args to init // FREEBIE 9 years ago			`inThread:(nullable TSThread *)thread`
			`messageBody:(nullable NSString *)body;`

			`- (instancetype)initWithTimestamp:(uint64_t)timestamp`
			`inThread:(nullable TSThread *)thread`
			`messageBody:(nullable NSString *)body`
Clarify message.attachments -> attachmentIds What we previously refered to as attachments are actually just the attachment's id (NSString). This has tripped me up a few too many times. Also, use generics with attachment id's array. // FREEBIE 9 years ago			`attachmentIds:(NSArray<NSString > )attachmentIds;`
Init Commit 10 years ago
disappearing messages * Support for disappearing messages * update inbox thread preview when receiving message // FREEBIE 9 years ago			`- (instancetype)initWithTimestamp:(uint64_t)timestamp`
			`inThread:(nullable TSThread *)thread`
			`messageBody:(nullable NSString *)body`
			`attachmentIds:(NSArray<NSString > )attachmentIds`
			`expiresInSeconds:(uint32_t)expiresInSeconds;`

			`- (instancetype)initWithTimestamp:(uint64_t)timestamp`
			`inThread:(nullable TSThread *)thread`
			`messageBody:(nullable NSString *)body`
			`attachmentIds:(NSArray<NSString > )attachmentIds`
			`expiresInSeconds:(uint32_t)expiresInSeconds`
Rework outgoing message state. // FREEBIE 8 years ago			`expireStartedAt:(uint64_t)expireStartedAt NS_DESIGNATED_INITIALIZER;`
disappearing messages * Support for disappearing messages * update inbox thread preview when receiving message // FREEBIE 9 years ago
			`- (nullable instancetype)initWithCoder:(NSCoder *)coder NS_DESIGNATED_INITIALIZER;`

Init Commit 10 years ago			`- (BOOL)hasAttachments;`
Don't start expiration of incoming messages until attachments are downloaded. // FREEBIE 8 years ago
Fix "unknown attachment" notifications The transaction in which the attachments were created hasn't been committed yet. // FREEBIE 8 years ago			`- (NSString )previewTextWithTransaction:(YapDatabaseReadTransaction )transaction;`
Init Commit 10 years ago
Don't start expiration of incoming messages until attachments are downloaded. // FREEBIE 8 years ago			`- (BOOL)shouldStartExpireTimer;`
			`- (BOOL)shouldStartExpireTimer:(YapDatabaseReadTransaction *)transaction;`

Respond to CR. // FREEBIE 8 years ago			`#pragma mark - Update With... Methods`
Rework the "update with..." methods to avoid re-saving deleted models. 8 years ago
			`- (void)updateWithExpireStartedAt:(uint64_t)expireStartedAt transaction:(YapDatabaseReadWriteTransaction *)transaction;`

Init Commit 10 years ago			`@end`
Some nullability annotations - prefer empty list (null object pattern!) for attachments vs nil - stop passing nil args to init // FREEBIE 9 years ago
			`NS_ASSUME_NONNULL_END`