PTCollaborationAnnotation

@interface PTCollaborationAnnotation : NSObject

A class that represents a PTAnnot for collaboration purposes. It is typically passed between an instance of a PTCollaborationManager, and an object that conforms to the PTCollaborationServerCommunication protocol as a means of describing annotations that have been created, modified and deleted.

  • The annotation’s unique ID.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *annotationID;

    Swift

    var annotationID: String? { get set }

  • The user ID of the annotation’s creator. This is defined by the PTCollaborationServerCommunication.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *userID;

    Swift

    var userID: String? { get set }

  • The user name of the annotation’s creator.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *userName;

    Swift

    var userName: String? { get set }

  • The XFDF representation of the annotation.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *xfdf;

    Swift

    var xfdf: String? { get set }

  • The annotation’s parent annotation’s annotationID.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *parent;

    Swift

    var parent: String? { get set }

  • The unique ID of the document with which this annotation is associated.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *documentID;

    Swift

    var documentID: String? { get set }

Validation

  • Whether the annotation is valid for an add action.

    Declaration

    Objective-C

    @property (readonly, getter=isValidForAdd, nonatomic) BOOL validForAdd;

    Swift

    var isValidForAdd: Bool { get }

  • Whether the annotation is valid for a modify action.

    Declaration

    Objective-C

    @property (readonly, getter=isValidForModify, nonatomic) BOOL validForModify;

    Swift

    var isValidForModify: Bool { get }

  • Whether the annotation is valid for a remove action.

    Declaration

    Objective-C

    @property (readonly, getter=isValidForRemove, nonatomic) BOOL validForRemove;

    Swift

    var isValidForRemove: Bool { get }