keychain/ckks/CKKSCurrentItemPointer.h

   1 /*
   2  * Copyright (c) 2017 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #import <Foundation/Foundation.h>
  25
  26 #import "keychain/ckks/CKKS.h"
  27 #import "keychain/ckks/CKKSItem.h"
  28 #import "keychain/ckks/CKKSKey.h"
  29
  30 #if OCTAGON
  31
  32 @interface CKKSCurrentItemPointer : CKKSCKRecordHolder
  33
  34 @property CKKSProcessedState* state;
  35 @property NSString* identifier;
  36 @property NSString* currentItemUUID;
  37
  38 - (instancetype)initForIdentifier:(NSString*)identifier
  39                   currentItemUUID:(NSString*)currentItemUUID
  40                             state:(CKKSProcessedState*)state
  41                            zoneID:(CKRecordZoneID*)zoneID
  42                   encodedCKRecord:(NSData*)encodedrecord;
  43
  44 + (instancetype)fromDatabase:(NSString*)identifier
  45                        state:(CKKSProcessedState*)state
  46                       zoneID:(CKRecordZoneID*)zoneID
  47                        error:(NSError* __autoreleasing*)error;
  48 + (instancetype)tryFromDatabase:(NSString*)identifier
  49                           state:(CKKSProcessedState*)state
  50                          zoneID:(CKRecordZoneID*)zoneID
  51                           error:(NSError* __autoreleasing*)error;
  52
  53 + (NSArray<CKKSCurrentItemPointer*>*)remoteItemPointers:(CKRecordZoneID*)zoneID error:(NSError* __autoreleasing*)error;
  54 + (bool)deleteAll:(CKRecordZoneID*)zoneID error:(NSError* __autoreleasing*)error;
  55 + (NSArray<CKKSCurrentItemPointer*>*)allInZone:(CKRecordZoneID*)zoneID error:(NSError* __autoreleasing*)error;
  56
  57 @end
  58
  59 #endif