Class Photos


  • public final class Photos
    extends java.lang.Object
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String PHContentEditingInputCancelledKey()  
      static java.lang.String PHContentEditingInputErrorKey()  
      static java.lang.String PHContentEditingInputResultIsInCloudKey()
      Completion handler info dictionary keys
      static java.lang.String PHImageCancelledKey()
      key (NSNumber): result is not available because the request was cancelled
      static java.lang.String PHImageErrorKey()
      key (NSError): NSFileManager or iCloud Photo Library errors
      static CGSize PHImageManagerMaximumSize()
      Size to pass when requesting the original image or the largest rendered image available (resizeMode will be ignored)
      static java.lang.String PHImageResultIsDegradedKey()
      key (NSNumber): result is a degraded image (only with async requests), meaning other images will be sent unless the request is cancelled in the meanwhile (note that the other request may fail if, for example, data is not available locally and networkAccessAllowed was not specified)
      static java.lang.String PHImageResultIsInCloudKey()
      key (NSNumber): result is in iCloud, meaning a new request will need to get issued (with networkAccessAllowed set) to get the result
      static java.lang.String PHImageResultRequestIDKey()
      key (NSNumber): Request ID of the request for this result
      static java.lang.String PHLivePhotoInfoCancelledKey()
      key : NSNumber containing a BOOL, YES when the result handler is being called after the request has been cancelled.
      static java.lang.String PHLivePhotoInfoErrorKey()
      key : NSError decribing an error that has occurred while creating the live photo
      static java.lang.String PHLivePhotoInfoIsDegradedKey()
      key : NSNumber containing a BOOL, YES whenever the deivered live photo object does not contain all content required for full playback.
      static java.lang.String PHLivePhotoShouldRenderAtPlaybackTime()
      Indicates whether processing should happen at playback time If set to NO (the default) the live photo will always be rendered before playback If set to YES, the editing context might still choose to render first for performance reasons This option is ignored by the saveLivePhotoToOutput method
      static java.lang.String PHLocalIdentifierNotFound()
      If the local object cannot be resolved from a global identifier, PHLocalIdentifierNotFound is provided in that array slot.
      static java.lang.String PHPhotosErrorDomain()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • PHLivePhotoRequestIDInvalid

        public static final int PHLivePhotoRequestIDInvalid
        See Also:
        Constant Field Values
      • PHInvalidImageRequestID

        public static final int PHInvalidImageRequestID
        See Also:
        Constant Field Values
      • PHInvalidAssetResourceDataRequestID

        public static final int PHInvalidAssetResourceDataRequestID
        See Also:
        Constant Field Values
    • Method Detail

      • PHLivePhotoInfoErrorKey

        public static java.lang.String PHLivePhotoInfoErrorKey()
        key : NSError decribing an error that has occurred while creating the live photo
      • PHLivePhotoInfoIsDegradedKey

        public static java.lang.String PHLivePhotoInfoIsDegradedKey()
        key : NSNumber containing a BOOL, YES whenever the deivered live photo object does not contain all content required for full playback.
      • PHLivePhotoInfoCancelledKey

        public static java.lang.String PHLivePhotoInfoCancelledKey()
        key : NSNumber containing a BOOL, YES when the result handler is being called after the request has been cancelled.
      • PHContentEditingInputResultIsInCloudKey

        public static java.lang.String PHContentEditingInputResultIsInCloudKey()
        Completion handler info dictionary keys
      • PHContentEditingInputCancelledKey

        public static java.lang.String PHContentEditingInputCancelledKey()
      • PHContentEditingInputErrorKey

        public static java.lang.String PHContentEditingInputErrorKey()
      • PHLivePhotoShouldRenderAtPlaybackTime

        public static java.lang.String PHLivePhotoShouldRenderAtPlaybackTime()
        Indicates whether processing should happen at playback time If set to NO (the default) the live photo will always be rendered before playback If set to YES, the editing context might still choose to render first for performance reasons This option is ignored by the saveLivePhotoToOutput method
      • PHImageManagerMaximumSize

        public static CGSize PHImageManagerMaximumSize()
        Size to pass when requesting the original image or the largest rendered image available (resizeMode will be ignored)
      • PHImageResultIsInCloudKey

        public static java.lang.String PHImageResultIsInCloudKey()
        key (NSNumber): result is in iCloud, meaning a new request will need to get issued (with networkAccessAllowed set) to get the result
      • PHImageResultIsDegradedKey

        public static java.lang.String PHImageResultIsDegradedKey()
        key (NSNumber): result is a degraded image (only with async requests), meaning other images will be sent unless the request is cancelled in the meanwhile (note that the other request may fail if, for example, data is not available locally and networkAccessAllowed was not specified)
      • PHImageResultRequestIDKey

        public static java.lang.String PHImageResultRequestIDKey()
        key (NSNumber): Request ID of the request for this result
      • PHImageCancelledKey

        public static java.lang.String PHImageCancelledKey()
        key (NSNumber): result is not available because the request was cancelled
      • PHImageErrorKey

        public static java.lang.String PHImageErrorKey()
        key (NSError): NSFileManager or iCloud Photo Library errors
      • PHPhotosErrorDomain

        public static java.lang.String PHPhotosErrorDomain()
      • PHLocalIdentifierNotFound

        public static java.lang.String PHLocalIdentifierNotFound()
        If the local object cannot be resolved from a global identifier, PHLocalIdentifierNotFound is provided in that array slot.