Namespace: annotations

belhop. annotations

This namespace contains APIs for interacting with annotations.

Methods

staticbelhop.annotations.getType(prefix, cb) /u01/opt/atlassian/bamboo-home/build-dir/8454146/BH-BN-JOB1/src/belhop.js, line 1586

Get an annotation type.

Name	Type	Description
`prefix`	string	The annotation type’s prefix
`cb`	belhop.Callback	An `belhop.AnnotationType`; `null` if not found

staticbelhop.annotations.getTypes(cb) /u01/opt/atlassian/bamboo-home/build-dir/8454146/BH-BN-JOB1/src/belhop.js, line 1551

Get annotation types.

Name	Type	Description
`cb`	belhop.Callback	Zero or more `belhop.AnnotationType`

staticbelhop.annotations.getValue(prefix, value, cb) /u01/opt/atlassian/bamboo-home/build-dir/8454146/BH-BN-JOB1/src/belhop.js, line 1629

Get an annotation value.

Name	Type	Description
`prefix`	string	The annotation type’s prefix
`value`	string	The annotation type’s value
`cb`	belhop.Callback	`belhop.AnnotationValue` if it exists; `null` if not

staticbelhop.annotations.search(searchTerm, cb) /u01/opt/atlassian/bamboo-home/build-dir/8454146/BH-BN-JOB1/src/belhop.js, line 1724

Search across all annotation values.

Name	Type	Description
`searchTerm`	string	Search term
`cb`	belhop.Callback	Zero or more `belhop.AnnotationValue`

staticbelhop.annotations.searchByType(type, searchTerm, cb) /u01/opt/atlassian/bamboo-home/build-dir/8454146/BH-BN-JOB1/src/belhop.js, line 1671

Search annotation values of a specific type.

Name	Type	Description
`type`	string \| belhop.AnnotationType	The annotation type
`searchTerm`	string	Search term
`cb`	belhop.Callback	Zero or more `belhop.AnnotationValue`