CKKSManifestLeafRecord.h   [plain text]

/*
 * Copyright (c) 2016 Apple Inc. All Rights Reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_LICENSE_HEADER_END@
 */

#if OCTAGON

#import <Foundation/Foundation.h>
#import "CKKSRecordHolder.h"

@class CKRecord;
@class CKKSItem;

NS_ASSUME_NONNULL_BEGIN

@interface CKKSManifestLeafRecord : CKKSCKRecordHolder

+ (BOOL)recordExistsForID:(NSString*)recordID;
+ (instancetype)leafRecordForID:(NSString*)recordID error:(NSError* __autoreleasing*)error;
+ (instancetype)tryLeafRecordForID:(NSString*)recordID error:(NSError* __autoreleasing*)error;
+ (NSString*)leafUUIDForRecordID:(NSString*)recordID;

@property (nonatomic, readonly) NSString* uuid;
@property (nonatomic, readonly) NSData* digestValue;
@property (nonatomic, readonly) NSDictionary<NSString*, NSData*>* recordDigestDict;  // keyed by record UUID

@end

@interface CKKSManifestPendingLeafRecord : CKKSManifestLeafRecord

- (nullable CKKSManifestLeafRecord*)commitToDatabaseWithError:(NSError**)error;

@end

@interface CKKSEgoManifestLeafRecord : CKKSManifestLeafRecord

+ (instancetype)newLeafRecordInZone:(NSString*)zone;

- (void)addOrUpdateRecordUUID:(NSString*)uuid withEncryptedItemData:(NSData*)itemData;
- (void)addOrUpdateRecord:(CKRecord*)record;
- (void)deleteItemWithUUID:(NSString*)uuid;

@end

NS_ASSUME_NONNULL_END

#endif