searchSingleAnnotationVotes

Function
import { searchSingleAnnotationVotes } from "@esri/hub-annotations";
//
searchSingleAnnotationVotes({ url: annotationsUrl + "/0",
  annotation: {
    id: "Annotation1",
    type: "annotations",
    attributes: { description: "Great place!", ... }
  }).then(response => {
    //   data: [{
    //     id,
    //     type: "votes",
    //     attributes: {
    //       upVotes: 3,
    //       downVotes: 0
    //     }
    //   }]
   });

Query for up and down votes on a single annotation from ArcGIS Hub.

Parameters

Parameter Type Default Notes
requestOptions Required ISearchAnnoOptions

request options that may include authentication

Available requestOptions

Property Type Notes
annotation IAnnoFeature
url string
authentication Optional Inherited IAuthenticationManager

The instance of IAuthenticationManager to use to authenticate this request.

credentials Optional Inherited RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

distance Optional Inherited number
f Optional Inherited "json" | "geojson" | "pbf"

Response format. Defaults to "json" NOTE: for "pbf" you must also supply rawResponse: true and parse the response yourself using response.arrayBuffer()

fetch Optional Inherited function(input: RequestInfo, init: RequestInit) : Promise<Response>

The implementation of fetch to use. Defaults to a global fetch.

gdbVersion Optional Inherited string
geometry Optional Inherited IGeometry
geometryPrecision Optional Inherited number
geometryType Optional Inherited GeometryType
groupByFieldsForStatistics Optional Inherited string
headers Optional Inherited [key: string]: any

Additional Headers to pass into the request.

hideToken Optional Inherited boolean

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.

historicMoment Optional Inherited number
httpMethod Optional Inherited HTTPMethods

The HTTP method to send the request with.

inSR Optional Inherited string | ISpatialReference
maxAllowableOffset Optional Inherited number
maxUrlLength Optional Inherited number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

multipatchOption Optional Inherited "xyFootprint"
objectIds Optional Inherited number[]
orderByFields Optional Inherited string
outFields Optional Inherited "*" | string[]

Attribute fields to include in the response. Defaults to "*"

outSR Optional Inherited string | ISpatialReference
outStatistics Optional Inherited IStatisticDefinition[]
params Optional Inherited IParams

Additional parameters to pass in the request.

portal Optional Inherited string

Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.

quantizationParameters Optional Inherited any
rawResponse Optional Inherited boolean

Return the raw response

relationParam Optional Inherited string
resultOffset Optional Inherited number
resultRecordCount Optional Inherited number
resultType Optional Inherited "none" | "standard" | "tile"
returnCentroid Optional Inherited boolean
returnCountOnly Optional Inherited boolean
returnDistinctValues Optional Inherited boolean
returnExceededLimitFeatures Optional Inherited boolean
returnExtentOnly Optional Inherited boolean
returnGeometry Optional Inherited boolean
returnIdsOnly Optional Inherited boolean
returnM Optional Inherited boolean
returnTrueCurves Optional Inherited false
returnZ Optional Inherited boolean
spatialRel Optional Inherited SpatialRelationship
sqlFormat Optional Inherited "none" | "standard" | "native"
time Optional Inherited number | number[]
units Optional Inherited Units
where Optional Inherited string

A where clause for the query. Defaults to "1=1"

Returns

A Promise that will resolve with summary statistics for the specified annotation from the annotation service for a Hub enabled ArcGIS Online organization.

Promise<{
data:
IVoteResourceObject[]
}>

Function defined in packages/annotations/src/search.ts:163