HTTP Driver

RSS

The http driver retrives web page content and posts data to web servers.

Manufacturer: N/A

Primary Communications Port: Network

Table of Contents [Hide/Show]

Configuration Settings
Events
   Ready State Changed
Instance Properties
   DeviceDisplayName
   DeviceStartTime
   DeviceLifecycleStage
   DeviceIsRunningAndReady
Instance Methods
   RetrieveWebPage ( String )
   RetrieveWebPage ( String, String, String )
   RetrieveWebPage ( String, String, String, String, String, String )
   SetPropertyForDuration ( String, TimeSpan, Object, Object )
   SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )

Configuration Settings

Events

Ready State Changed

The device's running and ready state changed.

Whenever Filter:

none

EventArgs:

Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Instance Properties

DeviceDisplayName

The display name for this device.

Accessibility : Read Only

Type: String

DeviceStartTime

The date and time when this device was started.

Accessibility : Read Only

Type: DateTime

DeviceLifecycleStage

The current lifecycle stage of the device. The stages in order are: Pending Start, Starting, Running, Stopping

Accessibility : Read Only

Type: Number

DeviceIsRunningAndReady

Indicates if the device is ready for use, ie it is in the Running lifecycle stage and all properties are valid and all methods are ready to be used.

Accessibility : Read Only

Type: Boolean

Instance Methods

RetrieveWebPage ( String )

Retrieves web page content using the "GET" http protocol method.

Syntax

String RetrieveWebPage( String url )

Parameters

url : The url of the web page to retrieve.

RetrieveWebPage ( String, String, String )

Retrieves web page content using the "GET" http protocol method and the specified authentication information.

Syntax

String RetrieveWebPage( String url, String username, String password )

Parameters

url : The url of the web page to retrieve.

username : The username to authenticate with.

password : The password to authenticate with.

RetrieveWebPage ( String, String, String, String, String, String )

Retrieves a web page.

Syntax

String RetrieveWebPage( String url, String method, String contentType, String postData, String username, String password )

Parameters

url : The url of the web page to retrieve.

method : The protocol method to use. Usually GET or POST.

contentType : The content type of the POST request data being sent (usually "application/x-www-form-urlencoded").

postData : The data to post (must be urlencoded).

username : The username to authenticate with.

password : The password to authenticate with.

SetPropertyForDuration ( String, TimeSpan, Object, Object )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax

void SetPropertyForDuration( String propertyName, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.

duration : The amount of time to wait after setting the initial value to set the subsequent value.

initialValue : The value to set the property to initially.

finalValue : The value to set the property to after the duration of time has passed.

SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )

void SetPropertyForDuration( String propertyName, Number arrayIndex, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.

arrayIndex : The property's array index to set.

duration : The amount of time to wait after setting the initial value to set the subsequent value.

initialValue : The value to set the property to initially.

finalValue : The value to set the property to after the duration of time has passed.