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