DITAttachmentFetchEvent Class Reference
DITAttachmentFetchEvent
@interface DITAttachmentFetchEvent : NSObjectA representation of the events that can occur in relation to an attachment fetch.
There are three different attachment fetch events: Completed, Progress, or Deleted.
There will be at most one Completed or Deleted event per attachment fetch. There can be many
Progress events delivered for each attachment fetch.
Updates relating to an attachment fetch are delivered by registering a DITAttachmentFetcher
through a call to fetchAttachment on a DITCollection instance.
-
The attachment fetch event’s type.
Check this value before using one of
asCompleted,asProgress, orasDeletedto ensure that you get a richer attachment fetch event object of the correct type.Declaration
Objective-C
@property (nonatomic, readonly) DITAttachmentFetchEventType type; -
Return the attachment fetch event object as a
DITAttachmentFetchEventCompletedobject.Declaration
Objective-C
- (nullable DITAttachmentFetchEventCompleted *)asCompleted;Return Value
A
DITAttachmentFetchEventCompletedobject ornilif the attachment’s fetch event is not completed. -
Return the attachment fetch event object as a
DITAttachmentFetchEventProgressobject.Declaration
Objective-C
- (nullable DITAttachmentFetchEventProgress *)asProgress;Return Value
A
DITAttachmentFetchEventProgressobject ornilif the attachment’s fetch event is not progress. -
Return the attachment fetch event object as a
DITAttachmentFetchEventDeletedobject.Declaration
Objective-C
- (nullable DITAttachmentFetchEventDeleted *)asDeleted;Return Value
A
DITAttachmentFetchEventDeletedobject ornilif the attachment’s fetch event is not deleted.