keychain/ckks/CKKSIncomingQueueEntry.h

   1 /*
   2  * Copyright (c) 2016 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 #if OCTAGON
  25
  26 #import <CloudKit/CloudKit.h>
  27 #include "keychain/securityd/SecDbItem.h"
  28 #include <utilities/SecDb.h>
  29 #import "CKKSItem.h"
  30 #import "CKKSMirrorEntry.h"
  31 #import "CKKSSQLDatabaseObject.h"
  32
  33 NS_ASSUME_NONNULL_BEGIN
  34
  35 @interface CKKSIncomingQueueEntry : CKKSSQLDatabaseObject
  36
  37 @property CKKSItem* item;
  38 @property NSString* uuid;  // through-access to underlying item
  39
  40 @property NSString* action;
  41 @property NSString* state;
  42
  43 - (instancetype)initWithCKKSItem:(CKKSItem*)ckme action:(NSString*)action state:(NSString*)state;
  44
  45 + (instancetype _Nullable)fromDatabase:(NSString*)uuid zoneID:(CKRecordZoneID*)zoneID error:(NSError* __autoreleasing*)error;
  46 + (instancetype _Nullable)tryFromDatabase:(NSString*)uuid zoneID:(CKRecordZoneID*)zoneID error:(NSError* __autoreleasing*)error;
  47
  48 + (NSArray<CKKSIncomingQueueEntry*>* _Nullable)fetch:(ssize_t)n
  49                                       startingAtUUID:(NSString* _Nullable)uuid
  50                                                state:(NSString*)state
  51                                               action:(NSString* _Nullable)action
  52                                               zoneID:(CKRecordZoneID*)zoneID
  53                                                error:(NSError* __autoreleasing*)error;
  54
  55 + (NSDictionary<NSString*, NSNumber*>*)countsByStateInZone:(CKRecordZoneID*)zoneID error:(NSError* __autoreleasing*)error;
  56 + (NSInteger)countByState:(CKKSItemState *)state zone:(CKRecordZoneID*)zoneID error: (NSError * __autoreleasing *)error;
  57
  58 @end
  59
  60 NS_ASSUME_NONNULL_END
  61 #endif