Class Photos


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

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static @NotNull java.lang.String PHContentEditingInputCancelledKey()
      API-Since: 8.0
      static @NotNull java.lang.String PHContentEditingInputErrorKey()
      API-Since: 8.0
      static @NotNull java.lang.String PHContentEditingInputResultIsInCloudKey()
      Completion handler info dictionary keys API-Since: 8.0
      static @NotNull java.lang.String PHImageCancelledKey()
      key (NSNumber): result is not available because the request was cancelled API-Since: 8.0
      static @NotNull java.lang.String PHImageErrorKey()
      key (NSError): NSFileManager or iCloud Photo Library errors API-Since: 8.0
      static CGSize PHImageManagerMaximumSize()
      Size to pass when requesting the original image or the largest rendered image available (resizeMode will be ignored) API-Since: 8.0
      static @NotNull 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) API-Since: 8.0
      static @NotNull 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 API-Since: 8.0
      static @NotNull java.lang.String PHImageResultRequestIDKey()
      key (NSNumber): Request ID of the request for this result API-Since: 8.0
      static @NotNull java.lang.String PHLivePhotoInfoCancelledKey()
      key : NSNumber containing a BOOL, YES when the result handler is being called after the request has been cancelled.
      static @NotNull java.lang.String PHLivePhotoInfoErrorKey()
      key : NSError decribing an error that has occurred while creating the live photo API-Since: 9.1
      static @NotNull 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 @NotNull 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 API-Since: 11.0
      static java.lang.String PHLocalIdentifiersErrorKey()
      Array of NSString values representing local identifiers related to the specific error API-Since: 15.0
      static java.lang.String PHPhotosErrorDomain()
      API-Since: 13.0
      • 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
        API-Since: 9.1
        See Also:
        Constant Field Values
      • PHInvalidImageRequestID

        public static final int PHInvalidImageRequestID
        API-Since: 8.0
        See Also:
        Constant Field Values
      • PHInvalidAssetResourceDataRequestID

        public static final int PHInvalidAssetResourceDataRequestID
        API-Since: 9.0
        See Also:
        Constant Field Values
    • Method Detail

      • PHLivePhotoInfoErrorKey

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

        @NotNull
        public static @NotNull 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. API-Since: 9.1
      • PHLivePhotoInfoCancelledKey

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

        @NotNull
        public static @NotNull java.lang.String PHContentEditingInputResultIsInCloudKey()
        Completion handler info dictionary keys API-Since: 8.0
      • PHContentEditingInputCancelledKey

        @NotNull
        public static @NotNull java.lang.String PHContentEditingInputCancelledKey()
        API-Since: 8.0
      • PHContentEditingInputErrorKey

        @NotNull
        public static @NotNull java.lang.String PHContentEditingInputErrorKey()
        API-Since: 8.0
      • PHLivePhotoShouldRenderAtPlaybackTime

        @NotNull
        public static @NotNull 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 API-Since: 11.0
      • PHImageManagerMaximumSize

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

        @NotNull
        public static @NotNull 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 API-Since: 8.0
      • PHImageResultIsDegradedKey

        @NotNull
        public static @NotNull 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) API-Since: 8.0
      • PHImageResultRequestIDKey

        @NotNull
        public static @NotNull java.lang.String PHImageResultRequestIDKey()
        key (NSNumber): Request ID of the request for this result API-Since: 8.0
      • PHImageCancelledKey

        @NotNull
        public static @NotNull java.lang.String PHImageCancelledKey()
        key (NSNumber): result is not available because the request was cancelled API-Since: 8.0
      • PHImageErrorKey

        @NotNull
        public static @NotNull java.lang.String PHImageErrorKey()
        key (NSError): NSFileManager or iCloud Photo Library errors API-Since: 8.0
      • PHPhotosErrorDomain

        public static java.lang.String PHPhotosErrorDomain()
        API-Since: 13.0
      • PHLocalIdentifiersErrorKey

        public static java.lang.String PHLocalIdentifiersErrorKey()
        Array of NSString values representing local identifiers related to the specific error API-Since: 15.0