PSPDFAnnotationPlaceholderState

Objective-C

NS_CLOSED_ENUM(NSInteger, PSPDFAnnotationPlaceholderState) {
    /// The placeholder is still dormant.
    ///
    /// Its `progress` and `error` properties are both `nil`.
    PSPDFAnnotationPlaceholderStateIdle,

    /// The placeholder has become active.
    ///
    /// Its `progress` property is populated with an object that can be used to display the progress of
    /// replacing the placeholder with actual content. The placeholder’s `error` property is `nil`.
    PSPDFAnnotationPlaceholderStateProgressing,

    /// The process of replacing the placeholder with actual content has failed.
    ///
    /// The `progress` property is `nil`. The `error` property holds an object detailing why/in which
    /// way replacing the placeholder with actual content failed.
    PSPDFAnnotationPlaceholderStateFailed,

    /// The process of replacing the placeholder with actual content has been cancelled.
    PSPDFAnnotationPlaceholderStateCancelled,

    /// The actual content has become available.
    ///
    /// The placeholder has become obsolete, so neither its `progress`, not its `error` property matter
    /// anymore.
    PSPDFAnnotationPlaceholderStateCompleted,
}

Swift

@frozen enum PSPDFAnnotationPlaceholderState : Int

Undocumented

  • The placeholder is still dormant.

    Its `progress` and `error` properties are both `nil`.
    

    Declaration

    Objective-C

    PSPDFAnnotationPlaceholderStateIdle

    Swift

    case idle = 0
  • The placeholder has become active.

    Its `progress` property is populated with an object that can be used to display the progress of
    replacing the placeholder with actual content. The placeholders `error` property is `nil`.
    

    Declaration

    Objective-C

    PSPDFAnnotationPlaceholderStateProgressing

    Swift

    case progressing = 1
  • The process of replacing the placeholder with actual content has failed.

    The `progress` property is `nil`. The `error` property holds an object detailing why/in which
    way replacing the placeholder with actual content failed.
    

    Declaration

    Objective-C

    PSPDFAnnotationPlaceholderStateFailed

    Swift

    case failed = 2
  • The process of replacing the placeholder with actual content has been cancelled.

    Declaration

    Objective-C

    PSPDFAnnotationPlaceholderStateCancelled

    Swift

    case cancelled = 3
  • The actual content has become available.

    The placeholder has become obsolete, so neither its `progress`, not its `error` property matter
    anymore.
    

    Declaration

    Objective-C

    PSPDFAnnotationPlaceholderStateCompleted

    Swift

    case completed = 4