GDTCOREvent_Private.h 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. /*
  2. * Copyright 2018 Google
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. #import <GoogleDataTransport/GDTCOREvent.h>
  17. #import <GoogleDataTransport/GDTCORClock.h>
  18. NS_ASSUME_NONNULL_BEGIN
  19. @interface GDTCOREvent ()
  20. /** The unique ID of the event. This property is for testing only. */
  21. @property(nonatomic, readwrite) NSNumber *eventID;
  22. /** The GDT relative file path of the event. */
  23. @property(nullable, nonatomic, readonly) NSString *GDTFilePath;
  24. /** Writes [dataObject transportBytes] to the given URL, populates fileURL with the filename, then
  25. * nils the dataObject property. This method should not be called twice on the same event.
  26. *
  27. * @param filePath The GDTCORRootDirectory-relative path that dataObject will be written to.
  28. * @param error If populated, the error encountered during writing to disk.
  29. * @return YES if writing dataObject to disk was successful, NO otherwise.
  30. */
  31. - (BOOL)writeToGDTPath:(NSString *)filePath error:(NSError **)error;
  32. /** Generates incrementing event IDs, stored in a file in the app's cache.
  33. *
  34. * @return An event ID that is incremented based on a number in a file stored in the app cache.
  35. */
  36. + (NSNumber *)nextEventID;
  37. @end
  38. NS_ASSUME_NONNULL_END