Skip to content

ADPhotoKitUI

duzexu edited this page Nov 15, 2021 · 4 revisions

ADPhotoKitUI

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

public class ADPhotoKitUI 

Nested Type Aliases

Asset

Wrap of select asset.

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

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.

AssetSelectHandler

Return select assets and if original or not.

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

AssetableSelectHandler

Return browsable asset array.

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

AssetCancelHandler

Cancel select.

public typealias AssetCancelHandler = (() -> Void)

Properties

config

Config pass through.

public static var config: ADPhotoKitConfig!

Methods

imagePicker(present:style:models:albumOpts:assetOpts:browserOpts:params:selected:canceled:)

Show picker with select assets.

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) 

Parameters

  • on: The controller to show picker.
  • style: Style to display picker.
  • models: Asset models have been selected.
  • albumOpts: Options to limit album type and order. It is ADAlbumSelectOptions.default by default.
  • assetOpts: Options to control the asset select condition and ui. It is ADAssetSelectOptions.default by default.
  • browserOpts: Options to control browser controller. It is ADAssetBrowserOptions.default by default.
  • params: Params to control the asset select condition.
  • selected: Called after selection finish.
  • canceled: Called when cancel select.

assetBrowser(present:assets:selects:index:options:selected:canceled:)

Show controller to browser and select assets.

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

Parameters

  • on: The controller to show browser.
  • assets: Assets to browser.
  • selects: Assets heave been selected.
  • index: Current browser asset index.
  • options: Options to control browser controller. It is ADAssetBrowserOptions.default by default.
  • selected: Called after selection finish.
  • canceled: Called when cancel select.
Types
Protocols
Global Typealiases
Operators
Extensions

Clone this wiki locally