Module hypothesis::annotations[−][src]

Objects related to the “annotations” endpoint

Structs

Annotation	Full representation of an Annotation resource and applicable relationships.
Dc
Document
DocumentBuilder	Builder for `Document`.
HighWire
InputAnnotation	Struct to create annotations
InputAnnotationBuilder	Builder for `InputAnnotation`.
Link
Permissions
SearchQuery	Options to filter and sort search results. See the Hypothesis API docs for more details on using these fields
SearchQueryBuilder	Builder for `SearchQuery`.
Target	While the API accepts arbitrary Annotation selectors in the target.selector property, the Hypothesis client currently supports TextQuoteSelector, RangeSelector and TextPositionSelector selector. Hypothesis API v1.0.0
TargetBuilder	Builder for `Target`.
TextPositionSelector	This Selector describes a range of text by recording the start and end positions of the selection in the stream. Position 0 would be immediately before the first character, position 1 would be immediately before the second character, and so on. The start character is thus included in the list, but the end character is not.
TextQuoteSelector	This Selector describes a range of text by copying it, and including some of the text immediately before (a prefix) and after (a suffix) it to distinguish between multiple copies of the same sequence of characters.
UserInfo

Order
Selector	Many Annotations refer to part of a resource, rather than all of it, as the Target. We call that part of the resource a Segment (of Interest). A Selector is used to describe how to determine the Segment from within the Source resource. Web Annotation Data Model - Selectors
Sort