ADPhotoKit Documentation

Class ADPhoto​Kit​UI 

public class ADPhotoKitUI

Main class of ADPhotoKit UI. It provide methods to show asset picker or asset browser.

Nested Type Aliases

Asset 

public typealias Asset = (asset: PHAsset, result: ADAssetResult?, error: Error?)

Wrap of select asset.

Parameters

asset

Asset select from system.
result

Result fetch with asset. It's nil if not contain ImageEdit subspec and browserOpts not contain .fetchImage.
error

Error info when fetch error. It's not nil when error occur when fetching.

Asset​Select​Handler 

public typealias AssetSelectHandler = (([Asset],Bool) -> Void)

Return select assets and if original or not.

Assetable​Select​Handler 

public typealias AssetableSelectHandler = (([ADAssetBrowsable]) -> Void)

Return browsable asset array.

Asset​Cancel​Handler 

public typealias AssetCancelHandler = (() -> Void)

Cancel select.

Properties

config 

public static var config: ADPhotoKitConfig!

Config pass through.

Methods

image​Picker(present:​style:​models:​album​Opts:​asset​Opts:​browser​Opts:​params:​selected:​canceled:​) 

public class func imagePicker(present on: UIViewController,
                                    style: ADPickerStyle = .normal,
                                    models: [ADSelectAssetModel] = [],
                                    albumOpts: ADAlbumSelectOptions = .default,
                                    assetOpts: ADAssetSelectOptions = .default,
                                    browserOpts: ADAssetBrowserOptions = .default,
                                    params: Set<ADPhotoSelectParams> = [],
                                    selected: @escaping AssetSelectHandler,
                                    canceled: AssetCancelHandler? = nil)

Show picker with select assets.

Parameters

on UIView​Controller

The controller to show picker.
style ADPicker​Style

Style to display picker.
models [ADSelect​Asset​Model]

Asset models have been selected.
album​Opts ADAlbum​Select​Options

Options to limit album type and order. It is ADAlbumSelectOptions.default by default.
asset​Opts ADAsset​Select​Options

Options to control the asset select condition and ui. It is ADAssetSelectOptions.default by default.
browser​Opts ADAsset​Browser​Options

Options to control browser controller. It is ADAssetBrowserOptions.default by default.
params Set<ADPhoto​Select​Params>

Params to control the asset select condition.
selected @escaping Asset​Select​Handler

Called after selection finish.
canceled Asset​Cancel​Handler?

Called when cancel select.

asset​Browser(present:​assets:​selects:​index:​options:​selected:​canceled:​) 

public class func assetBrowser(present on: UIViewController,
                                    assets:  [ADAssetBrowsable],
                                    selects: [ADAssetBrowsable] = [],
                                    index: Int? = nil,
                                    options: ADAssetBrowserOptions = .default,
                                    selected: @escaping AssetableSelectHandler,
                                    canceled: AssetCancelHandler? = nil)

Show controller to browser and select assets.

Parameters

on UIView​Controller

The controller to show browser.
assets [ADAsset​Browsable]

Assets to browser.
selects [ADAsset​Browsable]

Assets heave been selected.
index Int?

Current browser asset index.
options ADAsset​Browser​Options

Options to control browser controller. It is ADAssetBrowserOptions.default by default.
selected @escaping Assetable​Select​Handler

Called after selection finish.
canceled Asset​Cancel​Handler?

Called when cancel select.