146 lines
7.7 KiB
Objective-C
146 lines
7.7 KiB
Objective-C
//
|
|
// Copyright 2017 Signal Messenger, LLC
|
|
// SPDX-License-Identifier: AGPL-3.0-only
|
|
//
|
|
|
|
#import <SignalServiceKit/OWSReadTracking.h>
|
|
#import <SignalServiceKit/TSMessage.h>
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
@class SDSAnyWriteTransaction;
|
|
@class SignalServiceAddress;
|
|
@class TSContactThread;
|
|
@class TSGroupThread;
|
|
@class TSIncomingMessageBuilder;
|
|
|
|
@interface TSIncomingMessage : TSMessage <OWSReadTracking>
|
|
|
|
/// Derived from the value of the `X-Signal-Timestamp` header when receiving a
|
|
/// message from the server, this represents the server-timestamp at which we
|
|
/// popped the message off the queue.
|
|
@property (nonatomic, readonly) uint64_t serverDeliveryTimestamp;
|
|
|
|
/// Derived from the `serverTimestamp` field on an incoming message `Envelope`,
|
|
/// this represents the server-timestamp at which the sender uploaded the
|
|
/// message to the server.
|
|
@property (nonatomic, readonly, nullable) NSNumber *serverTimestamp;
|
|
|
|
/// Derived from the server-populated `serverGuid` field on an incoming message
|
|
/// `Envelope`, this represents a server-generated UUID for this message.
|
|
@property (nonatomic, readonly, nullable) NSString *serverGuid;
|
|
|
|
@property (nonatomic, readonly) BOOL wasReceivedByUD;
|
|
|
|
- (instancetype)initMessageWithBuilder:(TSMessageBuilder *)messageBuilder NS_UNAVAILABLE;
|
|
|
|
- (instancetype)initWithGrdbId:(int64_t)grdbId
|
|
uniqueId:(NSString *)uniqueId
|
|
receivedAtTimestamp:(uint64_t)receivedAtTimestamp
|
|
sortId:(uint64_t)sortId
|
|
timestamp:(uint64_t)timestamp
|
|
uniqueThreadId:(NSString *)uniqueThreadId
|
|
body:(nullable NSString *)body
|
|
bodyRanges:(nullable MessageBodyRanges *)bodyRanges
|
|
contactShare:(nullable OWSContact *)contactShare
|
|
deprecated_attachmentIds:(nullable NSArray<NSString *> *)deprecated_attachmentIds
|
|
editState:(TSEditState)editState
|
|
expireStartedAt:(uint64_t)expireStartedAt
|
|
expireTimerVersion:(nullable NSNumber *)expireTimerVersion
|
|
expiresAt:(uint64_t)expiresAt
|
|
expiresInSeconds:(unsigned int)expiresInSeconds
|
|
giftBadge:(nullable OWSGiftBadge *)giftBadge
|
|
isGroupStoryReply:(BOOL)isGroupStoryReply
|
|
isSmsMessageRestoredFromBackup:(BOOL)isSmsMessageRestoredFromBackup
|
|
isViewOnceComplete:(BOOL)isViewOnceComplete
|
|
isViewOnceMessage:(BOOL)isViewOnceMessage
|
|
linkPreview:(nullable OWSLinkPreview *)linkPreview
|
|
messageSticker:(nullable MessageSticker *)messageSticker
|
|
quotedMessage:(nullable TSQuotedMessage *)quotedMessage
|
|
storedShouldStartExpireTimer:(BOOL)storedShouldStartExpireTimer
|
|
storyAuthorUuidString:(nullable NSString *)storyAuthorUuidString
|
|
storyReactionEmoji:(nullable NSString *)storyReactionEmoji
|
|
storyTimestamp:(nullable NSNumber *)storyTimestamp
|
|
wasRemotelyDeleted:(BOOL)wasRemotelyDeleted NS_UNAVAILABLE;
|
|
|
|
- (nullable instancetype)initWithCoder:(NSCoder *)coder NS_DESIGNATED_INITIALIZER;
|
|
|
|
- (instancetype)initIncomingMessageWithBuilder:(TSIncomingMessageBuilder *)incomingMessageBuilder
|
|
NS_DESIGNATED_INITIALIZER NS_SWIFT_NAME(init(incomingMessageWithBuilder:));
|
|
|
|
// --- CODE GENERATION MARKER
|
|
|
|
// This snippet is generated by /Scripts/sds_codegen/sds_generate.py. Do not manually edit it, instead run
|
|
// `sds_codegen.sh`.
|
|
|
|
// clang-format off
|
|
|
|
- (instancetype)initWithGrdbId:(int64_t)grdbId
|
|
uniqueId:(NSString *)uniqueId
|
|
receivedAtTimestamp:(uint64_t)receivedAtTimestamp
|
|
sortId:(uint64_t)sortId
|
|
timestamp:(uint64_t)timestamp
|
|
uniqueThreadId:(NSString *)uniqueThreadId
|
|
body:(nullable NSString *)body
|
|
bodyRanges:(nullable MessageBodyRanges *)bodyRanges
|
|
contactShare:(nullable OWSContact *)contactShare
|
|
deprecated_attachmentIds:(nullable NSArray<NSString *> *)deprecated_attachmentIds
|
|
editState:(TSEditState)editState
|
|
expireStartedAt:(uint64_t)expireStartedAt
|
|
expireTimerVersion:(nullable NSNumber *)expireTimerVersion
|
|
expiresAt:(uint64_t)expiresAt
|
|
expiresInSeconds:(unsigned int)expiresInSeconds
|
|
giftBadge:(nullable OWSGiftBadge *)giftBadge
|
|
isGroupStoryReply:(BOOL)isGroupStoryReply
|
|
isSmsMessageRestoredFromBackup:(BOOL)isSmsMessageRestoredFromBackup
|
|
isViewOnceComplete:(BOOL)isViewOnceComplete
|
|
isViewOnceMessage:(BOOL)isViewOnceMessage
|
|
linkPreview:(nullable OWSLinkPreview *)linkPreview
|
|
messageSticker:(nullable MessageSticker *)messageSticker
|
|
quotedMessage:(nullable TSQuotedMessage *)quotedMessage
|
|
storedShouldStartExpireTimer:(BOOL)storedShouldStartExpireTimer
|
|
storyAuthorUuidString:(nullable NSString *)storyAuthorUuidString
|
|
storyReactionEmoji:(nullable NSString *)storyReactionEmoji
|
|
storyTimestamp:(nullable NSNumber *)storyTimestamp
|
|
wasRemotelyDeleted:(BOOL)wasRemotelyDeleted
|
|
authorPhoneNumber:(nullable NSString *)authorPhoneNumber
|
|
authorUUID:(nullable NSString *)authorUUID
|
|
deprecated_sourceDeviceId:(nullable NSNumber *)deprecated_sourceDeviceId
|
|
read:(BOOL)read
|
|
serverDeliveryTimestamp:(uint64_t)serverDeliveryTimestamp
|
|
serverGuid:(nullable NSString *)serverGuid
|
|
serverTimestamp:(nullable NSNumber *)serverTimestamp
|
|
viewed:(BOOL)viewed
|
|
wasReceivedByUD:(BOOL)wasReceivedByUD
|
|
NS_DESIGNATED_INITIALIZER NS_SWIFT_NAME(init(grdbId:uniqueId:receivedAtTimestamp:sortId:timestamp:uniqueThreadId:body:bodyRanges:contactShare:deprecated_attachmentIds:editState:expireStartedAt:expireTimerVersion:expiresAt:expiresInSeconds:giftBadge:isGroupStoryReply:isSmsMessageRestoredFromBackup:isViewOnceComplete:isViewOnceMessage:linkPreview:messageSticker:quotedMessage:storedShouldStartExpireTimer:storyAuthorUuidString:storyReactionEmoji:storyTimestamp:wasRemotelyDeleted:authorPhoneNumber:authorUUID:deprecated_sourceDeviceId:read:serverDeliveryTimestamp:serverGuid:serverTimestamp:viewed:wasReceivedByUD:));
|
|
|
|
// clang-format on
|
|
|
|
// --- CODE GENERATION MARKER
|
|
|
|
/// This field should always be ignored. In the beginning, we did not
|
|
/// store this value and so all rows would be 0. Then we started
|
|
/// storing it, but we never should have. Then we stopped.
|
|
/// In other words, DONT USE IT.
|
|
/// Kept only so sds codegen outputs code with backwards compatibility with our sql
|
|
/// table without needing to migrate or reindex TSInteraction.
|
|
@property (nonatomic, readonly, nullable) NSNumber *deprecated_sourceDeviceId;
|
|
|
|
@property (nonatomic, readonly) SignalServiceAddress *authorAddress;
|
|
@property (nonatomic, readonly, nullable) NSString *authorPhoneNumber;
|
|
@property (nonatomic, readonly, nullable) NSString *authorUUID;
|
|
|
|
@property (nonatomic, readonly, getter=wasViewed) BOOL viewed;
|
|
|
|
- (void)markAsViewedAtTimestamp:(uint64_t)viewedTimestamp
|
|
thread:(TSThread *)thread
|
|
circumstance:(OWSReceiptCircumstance)circumstance
|
|
transaction:(SDSAnyWriteTransaction *)transaction;
|
|
|
|
// convenience method for expiring a message which was just read
|
|
- (void)debugonly_markAsReadNowWithTransaction:(SDSAnyWriteTransaction *)transaction
|
|
NS_SWIFT_NAME(debugonly_markAsReadNow(transaction:));
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|