keychain/ckks/CKKSOutgoingQueueEntry.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 CKKSOutgoingQueueEntry_h
  31 #define CKKSOutgoingQueueEntry_h
  32
  33 #if OCTAGON
  34 #import <CloudKit/CloudKit.h>
  35
  36 @class CKKSKeychainView;
  37
  38 @interface CKKSOutgoingQueueEntry : CKKSSQLDatabaseObject
  39
  40 @property CKKSItem* item;
  41 @property NSString* uuid; // property access to underlying CKKSItem
  42
  43 @property NSString* action;
  44 @property NSString* state;
  45 @property NSString* accessgroup;
  46 @property NSDate* waitUntil; // If non-null, the time at which this entry should be processed
  47
  48 - (instancetype) initWithCKKSItem:(CKKSItem*) item
  49                            action:(NSString*) action
  50                             state:(NSString*) state
  51                         waitUntil:(NSDate*) waitUntil
  52                       accessGroup:(NSString*) accessgroup;
  53
  54 + (instancetype) withItem: (SecDbItemRef) item action: (NSString*) action ckks:(CKKSKeychainView*)ckks error: (NSError * __autoreleasing *) error;
  55 + (instancetype) fromDatabase: (NSString*) uuid state: (NSString*) state zoneID:(CKRecordZoneID*)zoneID error: (NSError * __autoreleasing *) error;
  56 + (instancetype) tryFromDatabase: (NSString*) uuid zoneID:(CKRecordZoneID*)zoneID error: (NSError * __autoreleasing *) error;
  57 + (instancetype) tryFromDatabase: (NSString*) uuid state: (NSString*) state zoneID:(CKRecordZoneID*)zoneID error: (NSError * __autoreleasing *) error;
  58
  59 + (NSArray<CKKSOutgoingQueueEntry*>*) fetch:(ssize_t) n state: (NSString*) state zoneID:(CKRecordZoneID*)zoneID error: (NSError * __autoreleasing *) error;
  60 + (NSArray<CKKSOutgoingQueueEntry*>*) allInState: (NSString*) state zoneID:(CKRecordZoneID*)zoneID error: (NSError * __autoreleasing *) error;
  61
  62 + (NSDictionary<NSString*,NSNumber*>*)countsByState:(CKRecordZoneID*)zoneID error: (NSError * __autoreleasing *) error;
  63
  64 @end
  65
  66 #endif
  67 #endif /* CKKSOutgoingQueueEntry_h */