GCKUIImageHints Class

  • GCKUIImageHints provides hints to GCKUIImagePicker about the desired image type and size for UI display.

  • It includes properties for image type, image size, and optional custom data for image identification.

  • Developers can use initializers to create GCKUIImageHints instances with specified image type, size, and custom data.

  • The customData property allows developers to pass arbitrary data to the GCKUIImagePicker for custom image selection logic.
Instance Methods | Properties
GCKUIImageHints Class Reference

Overview

An object that provides hints to a GCKUIImagePicker about the type and size of an image to be selected for display in the UI.

Since
3.0

Inherits NSObject, <NSCopying>, and <NSCoding>.

Instance Method Summary

(instancetype) - initWithImageType:imageSize:
 Convenience initializer. More...
 
(instancetype) - initWithImageType:imageSize:customData:
 Designated initializer. More...
 

Property Summary

GCKMediaMetadataImageType imageType
 The image type. More...
 
CGSize imageSize
 The size at which the image will be displayed. More...
 
NSObject< NSCoding > * customData
 Optional custom data that can be used to identify the image. More...
 

Method Detail

- (instancetype) initWithImageType: (GCKMediaMetadataImageType)  imageType
imageSize: (CGSize)  imageSize 

Convenience initializer.

Sets the custom data to nil.

Parameters
imageTypeThe image type.
imageSizeThe image size.
- (instancetype) initWithImageType: (GCKMediaMetadataImageType)  imageType
imageSize: (CGSize)  imageSize
customData: (NSObject< NSCoding > *__nullable)  customData 

Designated initializer.

Parameters
imageTypeThe image type.
imageSizeThe image size.
customDataThe arbitrary custom data that can be used by a custom GCKUIImagePicker to select an image.

Property Detail

- (GCKMediaMetadataImageType) imageType
readnonatomicassign

The image type.

- (CGSize) imageSize
readnonatomicassign

The size at which the image will be displayed.

- (NSObject<NSCoding>*) customData
readnonatomiccopy

Optional custom data that can be used to identify the image.

It must be key-value coding compliant.