Share via

HttpReceiverOptions interface

Package:
azure-iot-device

Options structure used to configure how often the HTTP receiver polls for messages. Each of these options is mutually exclusive, except for the drain boolean. Only one interval, at, cron or manualPolling shall be present in the options structure.

This is configured by calling setOptions with this as a property named receivePolicy inside of an HttpTransportOptions object which is inside of an DeviceClientOptions object.

See

Properties

at

Use this option to configure the receiver to receive only once at a specific time.
cron

Use a cron-formatted string
drain

Boolean indicating whether only one message should be received all messages should be drained.
interval

Interval in seconds at which the Azure IoT hub is going to be polled.
manualPolling

Does not poll and instead rely on the user calling the receive method.

Property Details

at

Use this option to configure the receiver to receive only once at a specific time.

at?: Date

Property Value

Date

cron

Use a cron-formatted string

cron?: string

Property Value

string

drain

Boolean indicating whether only one message should be received all messages should be drained.

drain?: boolean

Property Value

boolean

interval

Interval in seconds at which the Azure IoT hub is going to be polled.

interval?: number

Property Value

number

manualPolling

Does not poll and instead rely on the user calling the receive method.

manualPolling?: boolean

Property Value

boolean