ProgressView

@objc(PESDKProgressView)
public protocol ProgressView

To use a custom progress HUD when saving a photo or while downloading stickers etc., your progress view must implement this protocol. Please note that your custom progress view should disable user interaction in all parts of the editor. Changing state while the progress view is visible can cause unexpected behavior.

  • Displays the progress HUD with the given message.

    Declaration

    Swift

    func show(withMessage message: String)

    Parameters

    message

    The message to display in the progress HUD.

  • Hides the progress HUD.

    Declaration

    Swift

    func hide()
  • Changes the progress on the HUD.

    Declaration

    Swift

    @objc
    optional func setProgress(_ value: Double)

    Parameters

    value

    Progress from 0 to 1.

  • Displays the progress HUD with the given message, cancel text, and cancel handler.

    Declaration

    Swift

    @objc
    optional func show(withMessage message: String, cancelText: String, cancelHandler: @escaping () -> Void)

    Parameters

    message

    The message to display in the progress HUD.

    cancelText

    Title of the cancel button.

    cancelHandler

    Cancel handler that cancels the current action in progress.