184 lines
5.4 KiB
Objective-C
184 lines
5.4 KiB
Objective-C
//
|
|
// Copyright (c) 2018 Open Whisper Systems. All rights reserved.
|
|
//
|
|
|
|
#import <Mantle/MTLModel.h>
|
|
#import <SignalUtilitiesKit/ContactsManagerProtocol.h>
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
@class CNContact;
|
|
@class OWSAttachmentInfo;
|
|
@class SSKProtoDataMessage;
|
|
@class SSKProtoDataMessageContact;
|
|
@class TSAttachment;
|
|
@class TSAttachmentStream;
|
|
@class YapDatabaseReadTransaction;
|
|
@class YapDatabaseReadWriteTransaction;
|
|
|
|
extern BOOL kIsSendingContactSharesEnabled;
|
|
|
|
typedef NS_ENUM(NSUInteger, OWSContactPhoneType) {
|
|
OWSContactPhoneType_Home = 1,
|
|
OWSContactPhoneType_Mobile,
|
|
OWSContactPhoneType_Work,
|
|
OWSContactPhoneType_Custom,
|
|
};
|
|
|
|
NSString *NSStringForContactPhoneType(OWSContactPhoneType value);
|
|
|
|
@protocol OWSContactField <NSObject>
|
|
|
|
- (BOOL)ows_isValid;
|
|
|
|
- (NSString *)localizedLabel;
|
|
|
|
@end
|
|
|
|
#pragma mark -
|
|
|
|
@interface OWSContactPhoneNumber : MTLModel <OWSContactField>
|
|
|
|
@property (nonatomic, readonly) OWSContactPhoneType phoneType;
|
|
// Applies in the OWSContactPhoneType_Custom case.
|
|
@property (nonatomic, readonly, nullable) NSString *label;
|
|
|
|
@property (nonatomic, readonly) NSString *phoneNumber;
|
|
|
|
- (nullable NSString *)tryToConvertToE164;
|
|
|
|
@end
|
|
|
|
#pragma mark -
|
|
|
|
typedef NS_ENUM(NSUInteger, OWSContactEmailType) {
|
|
OWSContactEmailType_Home = 1,
|
|
OWSContactEmailType_Mobile,
|
|
OWSContactEmailType_Work,
|
|
OWSContactEmailType_Custom,
|
|
};
|
|
|
|
NSString *NSStringForContactEmailType(OWSContactEmailType value);
|
|
|
|
@interface OWSContactEmail : MTLModel <OWSContactField>
|
|
|
|
@property (nonatomic, readonly) OWSContactEmailType emailType;
|
|
// Applies in the OWSContactEmailType_Custom case.
|
|
@property (nonatomic, readonly, nullable) NSString *label;
|
|
|
|
@property (nonatomic, readonly) NSString *email;
|
|
|
|
@end
|
|
|
|
#pragma mark -
|
|
|
|
typedef NS_ENUM(NSUInteger, OWSContactAddressType) {
|
|
OWSContactAddressType_Home = 1,
|
|
OWSContactAddressType_Work,
|
|
OWSContactAddressType_Custom,
|
|
};
|
|
|
|
NSString *NSStringForContactAddressType(OWSContactAddressType value);
|
|
|
|
@interface OWSContactAddress : MTLModel <OWSContactField>
|
|
|
|
@property (nonatomic, readonly) OWSContactAddressType addressType;
|
|
// Applies in the OWSContactAddressType_Custom case.
|
|
@property (nonatomic, readonly, nullable) NSString *label;
|
|
|
|
@property (nonatomic, readonly, nullable) NSString *street;
|
|
@property (nonatomic, readonly, nullable) NSString *pobox;
|
|
@property (nonatomic, readonly, nullable) NSString *neighborhood;
|
|
@property (nonatomic, readonly, nullable) NSString *city;
|
|
@property (nonatomic, readonly, nullable) NSString *region;
|
|
@property (nonatomic, readonly, nullable) NSString *postcode;
|
|
@property (nonatomic, readonly, nullable) NSString *country;
|
|
|
|
@end
|
|
|
|
#pragma mark -
|
|
|
|
@interface OWSContactName : MTLModel
|
|
|
|
// The "name parts".
|
|
@property (nonatomic, nullable) NSString *givenName;
|
|
@property (nonatomic, nullable) NSString *familyName;
|
|
@property (nonatomic, nullable) NSString *nameSuffix;
|
|
@property (nonatomic, nullable) NSString *namePrefix;
|
|
@property (nonatomic, nullable) NSString *middleName;
|
|
|
|
@property (nonatomic, nullable) NSString *organizationName;
|
|
|
|
@property (nonatomic) NSString *displayName;
|
|
|
|
// Returns true if any of the name parts (which doesn't include
|
|
// organization name) is non-empty.
|
|
- (BOOL)hasAnyNamePart;
|
|
|
|
@end
|
|
|
|
#pragma mark -
|
|
|
|
@interface OWSContact : MTLModel
|
|
|
|
@property (nonatomic) OWSContactName *name;
|
|
|
|
@property (nonatomic, readonly) NSArray<OWSContactPhoneNumber *> *phoneNumbers;
|
|
@property (nonatomic, readonly) NSArray<OWSContactEmail *> *emails;
|
|
@property (nonatomic, readonly) NSArray<OWSContactAddress *> *addresses;
|
|
|
|
@property (nonatomic, readonly, nullable) NSString *avatarAttachmentId;
|
|
- (nullable TSAttachment *)avatarAttachmentWithTransaction:(YapDatabaseReadTransaction *)transaction;
|
|
- (void)removeAvatarAttachmentWithTransaction:(YapDatabaseReadWriteTransaction *)transaction;
|
|
|
|
- (void)saveAvatarImage:(UIImage *)image transaction:(YapDatabaseReadWriteTransaction *)transaction;
|
|
// "Profile" avatars should _not_ be saved to device contacts.
|
|
@property (nonatomic, readonly) BOOL isProfileAvatar;
|
|
|
|
- (instancetype)init NS_UNAVAILABLE;
|
|
|
|
- (void)normalize;
|
|
|
|
- (BOOL)ows_isValid;
|
|
|
|
- (NSString *)debugDescription;
|
|
|
|
#pragma mark - Creation and Derivation
|
|
|
|
- (OWSContact *)newContactWithName:(OWSContactName *)name;
|
|
|
|
- (OWSContact *)copyContactWithName:(OWSContactName *)name;
|
|
|
|
#pragma mark - Phone Numbers and Recipient IDs
|
|
|
|
- (NSArray<NSString *> *)systemContactsWithSignalAccountPhoneNumbers:(id<ContactsManagerProtocol>)contactsManager
|
|
NS_SWIFT_NAME(systemContactsWithSignalAccountPhoneNumbers(_:));
|
|
- (NSArray<NSString *> *)systemContactPhoneNumbers:(id<ContactsManagerProtocol>)contactsManager
|
|
NS_SWIFT_NAME(systemContactPhoneNumbers(_:));
|
|
- (NSArray<NSString *> *)e164PhoneNumbers NS_SWIFT_NAME(e164PhoneNumbers());
|
|
|
|
@end
|
|
|
|
#pragma mark -
|
|
|
|
// TODO: Move to separate source file, rename to OWSContactConversion.
|
|
@interface OWSContacts : NSObject
|
|
|
|
#pragma mark - System Contact Conversion
|
|
|
|
// `contactForSystemContact` does *not* handle avatars. That must be delt with by the caller
|
|
+ (nullable OWSContact *)contactForSystemContact:(CNContact *)systemContact;
|
|
|
|
+ (nullable CNContact *)systemContactForContact:(OWSContact *)contact imageData:(nullable NSData *)imageData;
|
|
|
|
#pragma mark - Proto Serialization
|
|
|
|
+ (nullable SSKProtoDataMessageContact *)protoForContact:(OWSContact *)contact;
|
|
|
|
+ (nullable OWSContact *)contactForDataMessage:(SSKProtoDataMessage *)dataMessage
|
|
transaction:(YapDatabaseReadWriteTransaction *)transaction;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|