SpatialPostGeofenceOptionalParams interface

Optional Parameters.

Extends
RequestOptionsBase

Properties

abortSignal

The signal which can be used to abort requests.

customHeaders

{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.

isAsync

If true, the request will use async event mechanism; if false, the request will be synchronized and do not trigger any event. The default value is false.

mode

Mode of the geofencing async event mechanism. Possible values include: 'All', 'EnterAndExit'

onDownloadProgress

Callback which fires upon download progress.

onUploadProgress

Callback which fires upon upload progress.

searchBuffer

The radius of the buffer around the geofence in meters that defines how far to search inside and outside the border of the fence against the coordinate that was provided when calculating the result. The minimum value is 0, and the maximum is 500. The default value is 50.

timeout

The number of milliseconds a request can take before automatically being terminated.

userTime

The user request time. If not presented in the request, the default value is DateTime.UtcNow.

Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

customHeaders

{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.

customHeaders?: [key: string]: string

Property Value

[key: string]: string

isAsync

If true, the request will use async event mechanism; if false, the request will be synchronized and do not trigger any event. The default value is false.

isAsync?: boolean

Property Value

boolean

mode

Mode of the geofencing async event mechanism. Possible values include: 'All', 'EnterAndExit'

mode?: GeofenceMode

Property Value

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

searchBuffer

The radius of the buffer around the geofence in meters that defines how far to search inside and outside the border of the fence against the coordinate that was provided when calculating the result. The minimum value is 0, and the maximum is 500. The default value is 50.

searchBuffer?: number

Property Value

number

timeout

The number of milliseconds a request can take before automatically being terminated.

timeout?: number

Property Value

number

userTime

The user request time. If not presented in the request, the default value is DateTime.UtcNow.

userTime?: string

Property Value

string