hypothesis-api-client 0.1.13

hypothesis-api-client

0.1.13

HypothesisClient ▸
- Static members
- .orderAnnotations

Need help reading this?

HypothesisClient

Hypothesis client class

new HypothesisClient(token: any, config: any)

Parameters

token (any) The token to query hypothes.is API

config (any) Configuration parameters for the client. See Config.js for an example.

Static Members

▸ orderAnnotations(annotations, order, sort)

Given a list of annotations, it ordered them by sort and in desc or asc order

orderAnnotations(annotations: any, order: any, sort: any): Array

Parameters

annotations (any)

order

(any
            = 'desc')

sort

(any
            = 'updated')

Returns

Array:

Instance Members

▸ createNewAnnotation(data, callback)

Giving an annotation data, it is created in Hypothes.is

createNewAnnotation(data: any, callback: any)

Parameters

data (any) Annotation body schema

callback (any) Function to execute after annotation creation

▸ createNewAnnotationsSequential(annotations, callback)

Creates in hypothes.is server sequentially a given list of annotations

createNewAnnotationsSequential(annotations: any, callback: any): any

Parameters

annotations (any) A list of annotation bodies

callback (any) Function to execute after annotations are created

Returns

any: progress Holds progress of creating process, current and max values in number of pending annotations to finish.

▸ createNewAnnotationsParallel(annotations, callback)

Create a list of annotations in parallel

createNewAnnotationsParallel(annotations: any, callback: any)

Parameters

annotations (any) A list of annotation bodies

callback (any) Function to execute after annotations are created

▸ createNewAnnotations(annotations, callback)

Given an array of annotations creates them in the hypothes.is server

createNewAnnotations(annotations: any, callback: any)

Parameters

annotations (any)

callback (any)

▸ getUserProfile(callback)

Returns users profile

getUserProfile(callback: any)

Parameters

callback (any)

▸ fetchAnnotation(id, callback)

Fetches an annotation by id

fetchAnnotation(id: any, callback: any)

Parameters

id (any)

callback (any)

▸ updateAnnotation(id, data, callback)

Updates the annotation with

updateAnnotation(id: any, data: any, callback: any)

Parameters

id (any)

data (any)

callback (any)

▸ deleteAnnotation(annotation, callback)

Given an annotation or annotation id string, it deletes from Hypothes.is

deleteAnnotation(annotation: any, callback: any)

Parameters

annotation (any)

callback (any)

▸ deleteAnnotations(annotations, callback)

Given a list of annotations or annotation ids, they are deleted in Hypothes.is

deleteAnnotations(annotations: any, callback: any)

Parameters

annotations (any) a list of annotations or list of strings with each id

callback (any)

▸ searchAnnotationsSequential(data, callback)

Search bulk annotations sequentially using search_after instead of offset

searchAnnotationsSequential(data: any, callback: any): {current: number, max: number}

Parameters

data (any)

callback (any)

Returns

{current: number, max: number}: Holds progress of searching process, current and max values in number of queries pending to finish the search.

▸ searchAnnotations(data, callback)

Search annotations

searchAnnotations(data: any, callback: any)

Parameters

data (any)

callback (any)

▸ getListOfGroups(data, callback)

Get list of groups for current user

getListOfGroups(data: any, callback: any)

Parameters

data (any)

callback (any)

▸ createNewGroup(data, callback)

Create a new, private group for the currently-authenticated user.

createNewGroup(data: any, callback: any)

Parameters

data (any) Check the body request schema in https://h.readthedocs.io/en/latest/api-reference/#operation/createGroup

callback (any)

▸ updateGroup(groupId, data, callback)

Update a group metadata: name, description or id (only for Authorities). Check: https://h.readthedocs.io/en/latest/api-reference/#tag/groups/paths/~1groups~1{id}/patch

updateGroup(groupId: any, data: any, callback: any)

Parameters

groupId (any)

data (any)

callback (any)

▸ fetchGroup(groupId, callback)

Retrieve a group data by its ID

fetchGroup(groupId: any, callback: any)

Parameters

groupId (any)

callback (any)

▸ removeAMemberFromAGroup(data, callback)

Remove a member from a Hypothes.is group. Currently only is allowed to remove yourself.

removeAMemberFromAGroup(data: any, callback: any)

Parameters

data (any)

callback (any)