OData Component

Properties   Methods   Events   Config Settings   Errors  

The OData component implements the Open Data Protocol (OData). It can be used to query, parse, and update or modify data contained within an OData service.

Syntax

nsoftware.IPWorks.OData

Remarks

The OData Component supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.

The OData component allows you to easily query OData services and create, update, and delete entries within a service. To query a service, you can set the ServiceRootURI to the service's root URI and ResourcePath to the collection within the service that you wish to query. Optionally you can set the Query*** properties to filter the results. QueryService can then be called to retrieve the results (which can be viewed via the Entry*** properties).

Example 1. Query a Service: OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc" OData1.ResourcePath = "Products" OData1.QueryService()

To create a new entry, you can set the ServiceRootURI to the service's root URI and ResourcePath to the collection within the service that you wish to add the entry to. The Entry*** properties can be set to the values you wish to use to create the entry. CreateEntry can then be called to create the entry.

Example 2. Create a New Entry: OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc" OData1.ResourcePath = "Products" OData1.EntryProperties OData1.CreateEntry()

If you wish to update an entry, you can set the ServiceRootURI to the service's root URI and ResourcePath to the specific entry you wish to update. The Entry*** properties can be set to the values you wish to update. UpdateEntry can then be called to update the entry.

Example 3. Update an Entry: OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc" OData1.ResourcePath = "Products(1)" // Index 1 is the "Name" property. OData1.EntryProperties[1].Value = "MyNewName" OData1.UpdateEntry()

Deleting an entry requires that you first set the ServiceRootURI to the service's root URI and ResourcePath to the specific entry you wish to delete. DeleteEntry can then be called to delete the entry.

Example 4. Delete an Entry: OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc" OData1.ResourcePath = "Products(1)" OData1.DeleteEntry()

In addition to querying a service and manipulating its containing data, the OData component also allows you to retrieve the schema (metadata document) to determine the structure of a service. After setting ServiceRootURI to the root URI of the service, GetSchema can be called to retrieve the metadata document. The Schema*** properties will be populated upon successful retrieval of the metadata document allowing you to identify the structure of the service.

Example 5. Retrieve the Scheme: OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc" OData1.GetSchema()

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

Authorization Property (OData Component)

This property includes the Authorization string to be sent to the server.

Syntax

• C#
• VB.NET

public string Authorization { get; set; }

Public Property Authorization As String

Default Value

""

Remarks

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

AuthScheme Property (OData Component)

This property specifies the authentication scheme to use when server authentication is required.

Syntax

• C#
• VB.NET

public ODataAuthSchemes AuthScheme { get; set; }

enum ODataAuthSchemes {
  authBasic,
  authDigest,
  authProprietary,
  authNone,
  authNtlm,
  authNegotiate,
  authOAuth
}

Public Property AuthScheme As OdataAuthSchemes

Enum ODataAuthSchemes
  authBasic
  authDigest
  authProprietary
  authNone
  authNtlm
  authNegotiate
  authOAuth
End Enum

Default Value

0

Remarks

This property will tell the component which type of authorization to perform when the User and Password properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the User and Password properties are set, the component will attempt HTTP Basic Authentication. If AuthScheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token must be supplied through the Authorization property.

If AuthScheme is set to authOAuth (6), then the authorization string must be supplied through the Authorization property.

Note: If you set the Authorization property and AuthScheme is not authProprietary or authOAuth, then the AuthScheme will be set automatically to authProprietary (2) by the component.

For security, changing the value of this property will cause the component to clear the values of User, Password, and Authorization.

Channel Property (OData Component)

This includes the feed elements of a feed.

Syntax

• C#
• VB.NET

public AtomChannel Channel { get; set; }

Public Property Channel As AtomChannel

Remarks

This property contains the "feed" elements of an ATOM feed. The Channel property has fields that contain values for subelements of the "feed" element.

Cookies Property (OData Component)

A collection of cookies.

Syntax

• C#
• VB.NET

public HTTPCookieList Cookies { get; }

Public Property Cookies As HTTPCookieList

Remarks

This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type HTTPCookie) to this collection.

To see cookies that are set by the server, use the SetCookie event, which displays the cookies and their properties as set by the server. Those cookies also are added to Cookies.

MaxHTTPCookies can be used to control the maximum number of cookies saved.

This collection is indexed from 0 to count -1.

This property is not available at design time.

EntryAuthor Property (OData Component)

This property includes the author of the current entry in an OData feed.

Syntax

• C#
• VB.NET

public string EntryAuthor { get; set; }

Public Property EntryAuthor As String

Default Value

""

Remarks

This property contains the author of the specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that an author can be found).

This property is not applicable to OData V4 feeds.

This property is not available at design time.

EntryCount Property (OData Component)

This property includes the number of entries contained within an OData feed.

Syntax

• C#
• VB.NET

public int EntryCount { get; }

Public ReadOnly Property EntryCount As Integer

Default Value

0

Remarks

This property is updated to reflect the total number of entries returned within a response (whether you are retrieving a feed/entry or making changes to a feed/entry).

This property is read-only and not available at design time.

EntryETag Property (OData Component)

This property includes the ETag of the current entry in an OData feed.

Syntax

• C#
• VB.NET

public string EntryETag { get; set; }

Public Property EntryETag As String

Default Value

""

Remarks

This property is used to obtain the ETag of the specified entry within an OData feed and will be populated once the EntryIndex is set.

This property is also used when retrieving, updating, or deleting an entry. When EntryETag contains a nonempty string, an If-None-Match header will be sent with the entered value when QueryService is called. When DeleteEntry or UpdateEntry is called, an If-Match header will be sent with the entered value.

This property is not available at design time.

EntryId Property (OData Component)

This property includes the Id of the current entry in an OData feed.

Syntax

• C#
• VB.NET

public string EntryId { get; set; }

Public Property EntryId As String

Default Value

""

Remarks

This property contains the Id of the specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that an Id can be found).

This property is not available at design time.

EntryIndex Property (OData Component)

This property includes the index of the current entry in an OData feed.

Syntax

• C#
• VB.NET

public int EntryIndex { get; set; }

Public Property EntryIndex As Integer

Default Value

-1

Remarks

This property is used to specify an entry within a retrieved OData feed. Once set, EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, EntryProperties, and ResourcePath will be populated with their respective values found within the entry.

This property takes index values from 0 to EntryCount -1.

Setting EntryIndex to -1 will clear the entries contained by the component and also will reset EntryProperties and EntryCount.

This property is not available at design time.

EntryLinks Property (OData Component)

This property includes a collection of links in the current OData entry.

Syntax

• C#
• VB.NET

public ODataEntryLinkList EntryLinks { get; }

Public Property EntryLinks As ODataEntryLinkList

Remarks

This is a collection of links (referred to as Navigation Properties) in the current OData entry, as specified by EntryIndex. When EntryIndex is set, all of the elements in the entry are stored as ODataEntryLink types in this collection.

EntryProperties Property (OData Component)

This property includes a collection of elements in the current OData entry.

Syntax

• C#
• VB.NET

public ODataEntryPropertyList EntryProperties { get; }

Public Property EntryProperties As ODataEntryPropertyList

Remarks

This is a collection of elements in the current OData entry, as specified by EntryIndex. When EntryIndex is set, all of the elements in the entry are stored as ODataEntryProperty types in this collection.

EntrySummary Property (OData Component)

This property includes a summary of the current entry in an OData feed.

Syntax

• C#
• VB.NET

public string EntrySummary { get; set; }

Public Property EntrySummary As String

Default Value

""

Remarks

This property contains the summary of a specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that a summary can be found).

This property is not applicable to OData V4 feeds.

This property is not available at design time.

EntryTitle Property (OData Component)

This property includes the title of the current entry in an OData feed.

Syntax

• C#
• VB.NET

public string EntryTitle { get; set; }

Public Property EntryTitle As String

Default Value

""

Remarks

This property contains the title of a specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that a title can be found).

This property is not available at design time.

EntryType Property (OData Component)

This property includes the entry category or type.

Syntax

• C#
• VB.NET

public string EntryType { get; set; }

Public Property EntryType As String

Default Value

""

Remarks

This property specifies the entry category or type. When communicating with a service using OData V3, this property specifies the category element. When communicating with a service using OData V4, this property specifies the type attribute.

This property is not available at design time.

EntryUpdated Property (OData Component)

This property includes the date-time when a current entry in an OData feed was updated.

Syntax

• C#
• VB.NET

public string EntryUpdated { get; }

Public ReadOnly Property EntryUpdated As String

Default Value

""

Remarks

This property contains the date-time when a specified entry within an OData feed was updated. This value will be populated once EntryIndex is set (provided that a data-time can be found).

This property is not applicable to OData V4 feeds.

This property is read-only.

EntryXML Property (OData Component)

This property includes the raw XML of the current entry in an OData feed.

Syntax

• C#
• VB.NET

public string EntryXML { get; set; }

Public Property EntryXML As String

Default Value

""

Remarks

This property contains the raw XML of a specified entry within an OData feed. This value will be populated once EntryIndex is set.

This property is not available at design time.

Firewall Property (OData Component)

A set of properties related to firewall access.

Syntax

• C#
• VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

Idle Property (OData Component)

The current status of the component.

Syntax

• C#
• VB.NET

public bool Idle { get; }

Public ReadOnly Property Idle As Boolean

Default Value

True

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

LocalHost Property (OData Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C#
• VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As String

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

ODataVersion Property (OData Component)

This property includes the OData version.

Syntax

• C#
• VB.NET

public ODataODataVersions ODataVersion { get; set; }

enum ODataODataVersions {
  odV2,
  odV3,
  odV4,
  odAuto
}

Public Property ODataVersion As OdataODataVersions

Enum ODataODataVersions
  odV2
  odV3
  odV4
  odAuto
End Enum

Default Value

3

Remarks

This property specifies the OData version to be used in the request and expected in the response. Possible values are as follows:

• 0 (odV2)
• 1 (odv3)
• 3 (odV4)
• 4 (odAuto - default)

Once the version of the service has been automatically determined, it will continue to be used until Reset is called.

This property is not available at design time.

OtherHeaders Property (OData Component)

Other headers as determined by the user (optional).

Syntax

• C#
• VB.NET

public string OtherHeaders { get; set; }

Public Property OtherHeaders As String

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the component beyond what is provided.

This property is not available at design time.

OtherQueryOptions Property (OData Component)

This property includes additional query options to be used when querying a service.

Syntax

• C#
• VB.NET

public string OtherQueryOptions { get; set; }

Public Property OtherQueryOptions As String

Default Value

""

Remarks

This property allows you to specify additional query options that will be used when accessing a service. Query options consist of name-value pairs, and multiple entries should be separated with an "&" (i.e., name1=value1&name2=value2).

Note: All specified values will be appended (unaltered) to the end of the URL (generated by the combination of ServiceRootURI, ResourcePath, and any Query*** properties specified).

This property is not available at design time.

ParsedHeaders Property (OData Component)

This property includes a collection of headers returned from the last request.

Syntax

• C#
• VB.NET

public HeaderList ParsedHeaders { get; }

Public ReadOnly Property ParsedHeaders As HeaderList

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

This collection is indexed from 0 to count -1.

This property is read-only and not available at design time.

Password Property (OData Component)

This property includes a password if authentication is to be used.

Syntax

• C#
• VB.NET

public string Password { get; set; }

Public Property Password As String

Default Value

""

Remarks

This property contains a password if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, the User and Password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the component will attempt to authenticate using the current user's credentials.

Proxy Property (OData Component)

A set of properties related to proxy access.

Syntax

• C#
• VB.NET

public Proxy Proxy { get; set; }

Public Property Proxy As Proxy

Remarks

This property contains fields describing the proxy through which the component will attempt to connect.

QueryFilter Property (OData Component)

This property selects only the entries that satisfy the specified filter (expression).

Syntax

• C#
• VB.NET

public string QueryFilter { get; set; }

Public Property QueryFilter As String

Default Value

""

Remarks

This property allows you to specify a filter (expression) in which only the entries that satisfy it will be returned.

The following operators are supported in the expression language.

Logical Operators

Arithmetic Operators

Grouping Operators

The following functions are supported in the expression language.

String Functions

Date Functions

Math Functions

Type Functions

This property is not available at design time.

QueryOrderBy Property (OData Component)

This property includes the value used to order entries when querying a service.

Syntax

• C#
• VB.NET

public string QueryOrderBy { get; set; }

Public Property QueryOrderBy As String

Default Value

""

Remarks

This property allows you to specify a value by which the returned entries will be ordered after a call to QueryService.

Note: You can specify the order by which the entries are sorted (either ascending or descending) by appending asc or desc (respectively) to your OrderBy value. For example, if you want to sort the entries by Rating in descending order you would set QueryOrderBy to Rating desc. If a specific order (asc or desc) is not specified, the entries will be returned in ascending order.

This property is not available at design time.

QuerySelect Property (OData Component)

This property selects only the specified properties to be returned in an entry when querying a service.

Syntax

• C#
• VB.NET

public string QuerySelect { get; set; }

Public Property QuerySelect As String

Default Value

""

Remarks

This property allows you to specify the specific properties you want returned within an entry when calling QueryService. The specified value should be a comma-separated list of properties (provided you wish to have more than one property returned). For example, if you wish to have only the Name and Price of each item returned you can set QuerySelect to Name,Price.

Note: The specified values can be a property name, navigation property name (Title), or the "*" character, which returns all the properties for each entry.

This property is not available at design time.

QuerySkip Property (OData Component)

This property includes the number of entries to skip when querying a service.

Syntax

• C#
• VB.NET

public string QuerySkip { get; set; }

Public Property QuerySkip As String

Default Value

""

Remarks

This property allows you to specify the number of entries to skip (from the top of the list) when calling QueryService. Therefore when this property set, only the remaining entries (starting with entry N+1) will be returned. The specified value should not be a value less than zero.

By default, the service you are querying will sort the entries using a scheme selected by the OData service you are querying. You can, however, use QueryOrderBy to specify how the entries should be sorted before skipping the top N items.

This property can be used in conjunction with QueryOrderBy and QueryTop to select specific entries. For example, if you wanted to select the third and fourth highest rated item you would set QueryOrderBy to Rating desc (to order the items by Rating from highest to lowest), set QuerySkip to 2 (to skip the first and second items), and finally set QueryTop to 2 (to return only the third and fourth items).

This property is not available at design time.

QuerySkipToken Property (OData Component)

This property includes the token given by an OData server when the last query result collection is too large.

Syntax

• C#
• VB.NET

public string QuerySkipToken { get; set; }

Public Property QuerySkipToken As String

Default Value

""

Remarks

When a returned result collection is very large, it is not uncommon for the results to be broken up into multiple pages. When this occurs, a Skip Token is returned in the response and the component will populate QuerySkipToken with the returned value. Calling QueryService again will return the next page of results.

This property is not available at design time.

QueryTop Property (OData Component)

This property selects the first N entries when querying a service.

Syntax

• C#
• VB.NET

public string QueryTop { get; set; }

Public Property QueryTop As String

Default Value

""

Remarks

This property allows you to specify the number of entries (taken from the top of the list) to be returned when calling QueryService. The specified value should not be a value less than zero.

By default, the service you are querying will sort the entries using a scheme selected by the OData service you are querying. You can, however, use QueryOrderBy to specify how the entries should be sorted before selecting the top N items.

This property is not available at design time.

ResourcePath Property (OData Component)

This property includes the resource path of an OData service.

Syntax

• C#
• VB.NET

public string ResourcePath { get; set; }

Public Property ResourcePath As String

Default Value

""

Remarks

This property contains the resource path of an OData service and is used in conjunction with ServiceRootURI (ServiceRootURI/ResourcePath) to query feeds and modify entries.

This property will be populated when EntryIndex is set. You can change the value if you wish to send the request to a different resource path.

For example, a valid ResourcePath for the OData sample service is Products.

This property is not available at design time.

SchemaAssociation Property (OData Component)

This property includes the navigation properties and their corresponding associations contained within an entity of a service schema.

Syntax

• C#
• VB.NET

public ODataSchemaAssociation SchemaAssociation { get; }

Public ReadOnly Property SchemaAssociation As ODataSchemaAssociation

Remarks

This property is used to obtain the navigation properties and their corresponding associations contained within an entity (specified by SchemaEntityIndex) of a service schema. This property is populated after setting SchemaAssociationIndex.

This property is read-only and not available at design time.

SchemaAssociationCount Property (OData Component)

This property includes the number of navigation properties contained within an OData schema entity.

Syntax

• C#
• VB.NET

public int SchemaAssociationCount { get; }

Public ReadOnly Property SchemaAssociationCount As Integer

Default Value

0

Remarks

This property is updated to reflect the total number of navigation properties within the schema entity specified by SchemaEntityIndex.

This property is read-only and not available at design time.

SchemaAssociationIndex Property (OData Component)

This property includes the index of the current navigation property in an OData schema entity.

Syntax

• C#
• VB.NET

public int SchemaAssociationIndex { get; set; }

Public Property SchemaAssociationIndex As Integer

Default Value

0

Remarks

This property is used to specify a navigation property within an entity (specified by SchemaEntityIndex). Once set, SchemaAssociation will be populated.

This property is not available at design time.

SchemaEntity Property (OData Component)

This property includes the entities contained within a service schema.

Syntax

• C#
• VB.NET

public ODataSchemaEntity SchemaEntity { get; }

Public ReadOnly Property SchemaEntity As ODataSchemaEntity

Remarks

This property is used to obtain the entities of a service schema. This property is populated after setting SchemaEntityIndex.

This property is read-only and not available at design time.

SchemaEntityCount Property (OData Component)

This property includes the number of entities contained within an OData schema.

Syntax

• C#
• VB.NET

public int SchemaEntityCount { get; }

Public ReadOnly Property SchemaEntityCount As Integer

Default Value

0

Remarks

This property is updated to reflect the total number of entities within a schema (retrieved via GetSchema).

This property is read-only and not available at design time.

SchemaEntityIndex Property (OData Component)

This property includes the index of the current entity in an OData schema.

Syntax

• C#
• VB.NET

public int SchemaEntityIndex { get; set; }

Public Property SchemaEntityIndex As Integer

Default Value

0

Remarks

This property is used to specify an entity within a retrieved OData schema. Once set, SchemaEntity will be populated.

This property is not available at design time.

SchemaKeys Property (OData Component)

This property includes the keys for a schema entity.

Syntax

• C#
• VB.NET

public string[] SchemaKeys { get; }

Public ReadOnly Property SchemaKeys As String()

Default Value

Remarks

This property is used to obtain the keys contained within an entity for a service schema and is populated after setting SchemaEntityIndex.

Note: Key values map to a property of the entity, details of which can be retrieved via SchemaProperty.

This property is read-only and not available at design time.

SchemaProperty Property (OData Component)

This property includes the properties contained within an entity of a service schema.

Syntax

• C#
• VB.NET

public ODataSchemaProperty SchemaProperty { get; }

Public ReadOnly Property SchemaProperty As ODataSchemaProperty

Remarks

This property is used to obtain the properties contained within an entity (specified by SchemaEntityIndex) of a service schema. This property is populated after setting SchemaPropertyIndex.

Note: In reference to a database structure, a property would be a column.

This property is read-only and not available at design time.

SchemaPropertyCount Property (OData Component)

This property includes the number of properties contained within an OData schema entity.

Syntax

• C#
• VB.NET

public int SchemaPropertyCount { get; }

Public ReadOnly Property SchemaPropertyCount As Integer

Default Value

0

Remarks

This property is updated to reflect the total number of properties within the schema entity specified by SchemaEntityIndex.

This property is read-only and not available at design time.

SchemaPropertyIndex Property (OData Component)

This property includes the index of the current property in an OData schema entity.

Syntax

• C#
• VB.NET

public int SchemaPropertyIndex { get; set; }

Public Property SchemaPropertyIndex As Integer

Default Value

0

Remarks

This property is used to specify a property within an entity (specified by SchemaEntityIndex). Once set, SchemaProperty will be populated.

This property is not available at design time.

SchemaTypeField Property (OData Component)

This property includes the fields (properties) contained within a complex type.

Syntax

• C#
• VB.NET

public ODataSchemaProperty SchemaTypeField { get; }

Public ReadOnly Property SchemaTypeField As ODataSchemaProperty

Remarks

This property is used to obtain the fields (properties) contained within a complex type.

Note: It is populated when navigating an entity's properties via SchemaPropertyIndex or by explicitly setting the complex type name via SetSchemaType.

This property is read-only and not available at design time.

SchemaTypeFieldCount Property (OData Component)

This property includes the number of properties contained within an OData schema complex type.

Syntax

• C#
• VB.NET

public int SchemaTypeFieldCount { get; }

Public ReadOnly Property SchemaTypeFieldCount As Integer

Default Value

0

Remarks

This property is updated to reflect the total number of fields (properties) within the schema complex type of a property. This is populated when navigating an entity's properties via SchemaPropertyIndex or by explicitly setting the type via SetSchemaType.

This property is read-only and not available at design time.

SchemaTypeFieldIndex Property (OData Component)

This property includes the index of the current field (property) in an OData schema complex type.

Syntax

• C#
• VB.NET

public int SchemaTypeFieldIndex { get; set; }

Public Property SchemaTypeFieldIndex As Integer

Default Value

0

Remarks

This property is used to specify a field (property) within a complex type. Once set, SchemaTypeField will be populated.

This property is not available at design time.

ServiceRootURI Property (OData Component)

This property includes the root URI of an OData service.

Syntax

• C#
• VB.NET

public string ServiceRootURI { get; set; }

Public Property ServiceRootURI As String

Default Value

""

Remarks

This property contains the root URI of an OData service. This value is used in conjunction with ResourcePath (ServiceRootURI/ResourcePath) to query feeds and modify entries.

Example.

The ServiceRootURI of the OData sample service is "http://services.odata.org/OData/OData.svc/".

This property is not available at design time.

SSLAcceptServerCert Property (OData Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (OData Component)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (OData Component)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C#
• VB.NET

public ODataSSLProviders SSLProvider { get; set; }

enum ODataSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As OdataSSLProviders

Enum ODataSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (OData Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Timeout Property (OData Component)

The timeout for the component.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the component throws an exception.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

TransferredData Property (OData Component)

This property includes the contents of the last response from the server.

Syntax

• C#
• VB.NET

public string TransferredData { get; }
public byte[] TransferredDataB { get; }

Public ReadOnly Property TransferredData As String
Public ReadOnly Property TransferredDataB As Byte()

Default Value

""

Remarks

This property is used to get the data of the last response from the server.

TransferredData will be populated after a successful QueryService or CustomRequest call, provided that LocalFile is not set. If LocalFile is set, the object data will be written to the file specified.

This property is read-only and not available at design time.

User Property (OData Component)

This property includes a user name if authentication is to be used.

Syntax

• C#
• VB.NET

public string User { get; set; }

Public Property User As String

Default Value

""

Remarks

This property contains a user name if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM, and User and Password are empty, the component will attempt to authenticate using the current user's credentials.

Config Method (OData Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateEntry Method (OData Component)

This method creates a new entry within the specified OData service resource.

Syntax

• C#
• VB.NET

public void CreateEntry();

Async Version
public async Task CreateEntry();
public async Task CreateEntry(CancellationToken cancellationToken);

Public Sub CreateEntry()

Async Version
Public Sub CreateEntry() As Task
Public Sub CreateEntry(cancellationToken As CancellationToken) As Task

Remarks

The component will use the items contained within EntryProperties to create a new entry within the feed service resource by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath).

Upon a successful creation, all previous entries contained by the component, before the CreateEntry call, will be cleared and replaced with the response entry data. EntryIndex will then be set to 0 (the first entry within the response), populating the EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, and EntryProperties properties. OtherHeaders will also be cleared and thus will need to be reset accordingly with each call made.

CustomRequest Method (OData Component)

This method sends a request to the specified URL using the HTTPMethod and PostData provided.

Syntax

• C#
• VB.NET

public void CustomRequest(string HTTPMethod, string URL, string postData);

Async Version
public async Task CustomRequest(string HTTPMethod, string URL, string postData);
public async Task CustomRequest(string HTTPMethod, string URL, string postData, CancellationToken cancellationToken);

Public Sub CustomRequest(ByVal HTTPMethod As String, ByVal URL As String, ByVal PostData As String)

Async Version
Public Sub CustomRequest(ByVal HTTPMethod As String, ByVal URL As String, ByVal PostData As String) As Task
Public Sub CustomRequest(ByVal HTTPMethod As String, ByVal URL As String, ByVal PostData As String, cancellationToken As CancellationToken) As Task

Remarks

This method sends a custom request to the specified URL. The type of request sent is determined by HTTPMethod (e.g., POST) and the data sent are determined by PostData. If a custom request does not require data to be sent, simply set the PostData parameter to an empty string.

Note: All values specified are taken as entered.

OtherHeaders can be used to specify any additional headers you would like to be sent in the custom request.

The search results are delivered in the TransferredData property, as well as through the Transfer event. The response headers can be retrieved through the TransferredHeaders property as well as through the Header event.

The component will then attempt to parse the search results. Upon successfully parsing the response, Channel will be set with their associated feed element values and EntryCount will be populated with the total number of entries contained within the feed. EntryIndex also will be set to 1, thus populating EntryProperties.

DeleteEntry Method (OData Component)

This method deletes an entry within an OData service resource.

Syntax

• C#
• VB.NET

public void DeleteEntry();

Async Version
public async Task DeleteEntry();
public async Task DeleteEntry(CancellationToken cancellationToken);

Public Sub DeleteEntry()

Async Version
Public Sub DeleteEntry() As Task
Public Sub DeleteEntry(cancellationToken As CancellationToken) As Task

Remarks

The component will delete the entry, of an OData service resource, specified by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath).

An "If-Match" header will be sent in the delete request with the value contained within EntryETag.

Upon a successful entry deletion, all previous entries contained by the component, before the DeleteEntry call, will be cleared. OtherHeaders also will be cleared and thus will need to be reset accordingly with each call made.

GetEntryProperty Method (OData Component)

This method gets an OData entry property.

Syntax

• C#
• VB.NET

public string GetEntryProperty(string XPath);

Async Version
public async Task<string> GetEntryProperty(string XPath);
public async Task<string> GetEntryProperty(string XPath, CancellationToken cancellationToken);

Public Function GetEntryProperty(ByVal XPath As String) As String

Async Version
Public Function GetEntryProperty(ByVal XPath As String) As Task(Of String)
Public Function GetEntryProperty(ByVal XPath As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

This method is intended to extend the functionality of the OData component and will retrieve the value of the entry property specified by XPath. XPath is the XPath of the element or attribute according to the following convention: entry[x]/element@attribute. The @attribute part is optional. When EntryIndex is set to an index greater than or equal to zero, a relative path also can be used: property or property@attribute. When a relative path is specified, the value of the specified XPath will be returned for the entry identified by EntryIndex.

entry[x] is the feed's xth entry (or any other root-level child), where the indexer x starts at 1.

property is any child of the property's element, and attribute can be any attribute of that field. If an attribute is not supplied, the GetEntryProperty method will return the text portion of property.

Example 1. Attribute Not Supplied: ODataControl.GetEntryProperty("entry[5]/content/properties/ID") ODataControl.GetEntryProperty("entry[5]/content/properties/ID@type")

Example 2. Relative Path: In the following example, a relative path is used to retrieve properties of the first feed entry: ODataControl.EntryIndex = 1 ODataControl.GetEntryProperty("ID") ODataControl.GetEntryProperty("ID@type") ODataControl.GetEntryProperty("Address/State")

GetSchema Method (OData Component)

This method retrieves the schema for a service.

Syntax

• C#
• VB.NET

public void GetSchema();

Async Version
public async Task GetSchema();
public async Task GetSchema(CancellationToken cancellationToken);

Public Sub GetSchema()

Async Version
Public Sub GetSchema() As Task
Public Sub GetSchema(cancellationToken As CancellationToken) As Task

Remarks

This method will retrieve the schema (metadata document) of the service specified by ServiceRootURI.

Upon successful retrieval of the schema, set SchemaEntityIndex to retrieve the names of the entities contained within the schema along with their keys, properties, and navigation properties.

Additional details about the schema can be retrieved via XPath.

HasXPath Method (OData Component)

This method determines whether a specific element exists in the document.

Syntax

• C#
• VB.NET

public bool HasXPath(string XPath);

Async Version
public async Task<bool> HasXPath(string XPath);
public async Task<bool> HasXPath(string XPath, CancellationToken cancellationToken);

Public Function HasXPath(ByVal XPath As String) As Boolean

Async Version
Public Function HasXPath(ByVal XPath As String) As Task(Of Boolean)
Public Function HasXPath(ByVal XPath As String, cancellationToken As CancellationToken) As Task(Of Boolean)

Remarks

This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it through XPath.

This method returns True if the xpath exists, and False if not.

See XPath for details on the XPath syntax.

QueryService Method (OData Component)

This method queries an OData service using the specified parameters.

Syntax

• C#
• VB.NET

public void QueryService();

Async Version
public async Task QueryService();
public async Task QueryService(CancellationToken cancellationToken);

Public Sub QueryService()

Async Version
Public Sub QueryService() As Task
Public Sub QueryService(cancellationToken As CancellationToken) As Task

Remarks

This method queries an OData feed specified by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath) using the query options specified in the Query*** properties and OtherQueryOptions. To retrieve an OData feed, without performing any filtering, you can leave Query*** and OtherQueryOptions empty and call QueryService.

The query results are delivered in the TransferredData property, as well as through the Transfer event. The response headers can be retrieved through the ParsedHeaders property as well as through the Header event.

The component will attempt to parse the query results. Upon successfully parsing the response, Channel will be set with their associated feed element values and EntryCount will be populated with the total number of entries contained within the feed. EntryIndex will also be set to 1, thus populating EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, EntryProperties, and ResourcePath.

Reset Method (OData Component)

This method resets all of properties of the component.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

The Reset method resets all properties to the component's default settings. This is an easy way to clear all of the property values before repopulating the OData feed.

SetEntryProperty Method (OData Component)

This method is used to set an OData entry property.

Syntax

• C#
• VB.NET

public void SetEntryProperty(string XPath, string value);

Async Version
public async Task SetEntryProperty(string XPath, string value);
public async Task SetEntryProperty(string XPath, string value, CancellationToken cancellationToken);

Public Sub SetEntryProperty(ByVal XPath As String, ByVal Value As String)

Async Version
Public Sub SetEntryProperty(ByVal XPath As String, ByVal Value As String) As Task
Public Sub SetEntryProperty(ByVal XPath As String, ByVal Value As String, cancellationToken As CancellationToken) As Task

Remarks

This method is intended to extend functionality of the OData component and will set the value of the entry property (specified by XPath) to the specified Value. Therefore, the value of the corresponding property will be updated within EntryProperties.

XPath is the XPath of the element or attribute according to the following convention: entry[x]/element. When EntryIndex is set to an index greater than or equal to zero, a relative path can also be used: property. When a relative path is specified, the component will use the specified EntryIndex along with the property specified to update the EntryProperty value.

entry[x] is the feed's xth entry (or any other root-level child), where the indexer x starts at 1.

property is any child of the property's element.

Example 1. Set Properties: ODataControl.SetEntryProperty("entry[5]/content/properties/Name", "MyNewName") Example 2. Retrieve Properties:

The following example uses a relative path to retrieve properties of the first feed entry: ODataControl.EntryIndex = 1 ODataControl.SetEntryProperty("Name", "MyNewName") ODataControl.SetEntryProperty("Address/State", "NC")

SetSchemaEntity Method (OData Component)

This method sets the schema entity.

Syntax

• C#
• VB.NET

public void SetSchemaEntity(string name);

Async Version
public async Task SetSchemaEntity(string name);
public async Task SetSchemaEntity(string name, CancellationToken cancellationToken);

Public Sub SetSchemaEntity(ByVal Name As String)

Async Version
Public Sub SetSchemaEntity(ByVal Name As String) As Task
Public Sub SetSchemaEntity(ByVal Name As String, cancellationToken As CancellationToken) As Task

Remarks

The component will set the schema entity to the Name specified. Once set, you can view the keys (via SchemaKeys), properties (via SchemaProperty), and navigation properties (via SchemaAssociation) contained within the specified entity.

SetSchemaProperty Method (OData Component)

This method sets the schema property.

Syntax

• C#
• VB.NET

public void SetSchemaProperty(string name);

Async Version
public async Task SetSchemaProperty(string name);
public async Task SetSchemaProperty(string name, CancellationToken cancellationToken);

Public Sub SetSchemaProperty(ByVal Name As String)

Async Version
Public Sub SetSchemaProperty(ByVal Name As String) As Task
Public Sub SetSchemaProperty(ByVal Name As String, cancellationToken As CancellationToken) As Task

Remarks

The component will set the schema property to the Name specified. Once set, you can view the details of the property (via SchemaProperty) along with the complex type details (via SchemaTypeField); provided that the property is derived from the complex type.

SetSchemaType Method (OData Component)

This method sets the schema type.

Syntax

• C#
• VB.NET

public void SetSchemaType(string name);

Async Version
public async Task SetSchemaType(string name);
public async Task SetSchemaType(string name, CancellationToken cancellationToken);

Public Sub SetSchemaType(ByVal Name As String)

Async Version
Public Sub SetSchemaType(ByVal Name As String) As Task
Public Sub SetSchemaType(ByVal Name As String, cancellationToken As CancellationToken) As Task

Remarks

The component will set the schema type to the Name specified. Once set, you can view the details of the complex type (via SchemaTypeField).

UpdateEntry Method (OData Component)

This method updates an OData entry.

Syntax

• C#
• VB.NET

public void UpdateEntry();

Async Version
public async Task UpdateEntry();
public async Task UpdateEntry(CancellationToken cancellationToken);

Public Sub UpdateEntry()

Async Version
Public Sub UpdateEntry() As Task
Public Sub UpdateEntry(cancellationToken As CancellationToken) As Task

Remarks

The component will update the OData entry specified by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath). It also will update the OData entry with the elements specified by EntryProperties.

Upon a successful update, all previous entries contained by the component, before the UpdateEntry call, will be cleared and replaced with the response entry data. EntryIndex will then be set to zero (the first entry within the response), populating the EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, EntryProperties, and ResourcePath properties. OtherHeaders will also be cleared and thus will need to be reset accordingly with each call made.

UpdateProperty Method (OData Component)

This method updates an OData entry property.

Syntax

• C#
• VB.NET

public void UpdateProperty(string XPath, string value);

Async Version
public async Task UpdateProperty(string XPath, string value);
public async Task UpdateProperty(string XPath, string value, CancellationToken cancellationToken);

Public Sub UpdateProperty(ByVal XPath As String, ByVal Value As String)

Async Version
Public Sub UpdateProperty(ByVal XPath As String, ByVal Value As String) As Task
Public Sub UpdateProperty(ByVal XPath As String, ByVal Value As String, cancellationToken As CancellationToken) As Task

Remarks

The component will update the OData entry specified by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath). It will update only the single entry property specified by XPath with the specified Value.

Upon a successful update, all previous entries contained by the component, before the UpdateProperty call, will be cleared and replaced with the response entry data. EntryIndex will then be set to zero (the first entry within the response), populating the EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, EntryProperties, and ResourcePath. OtherHeaders will also be cleared and thus will need to be reset accordingly with each call made.

Connected Event (OData Component)

Fired immediately after a connection completes (or fails).

Syntax

• C#
• VB.NET

public event OnConnectedHandler OnConnected;

public delegate void OnConnectedHandler(object sender, ODataConnectedEventArgs e);

public class ODataConnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnected As OnConnectedHandler

Public Delegate Sub OnConnectedHandler(sender As Object, e As ODataConnectedEventArgs)

Public Class ODataConnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

Disconnected Event (OData Component)

Fired when a connection is closed.

Syntax

• C#
• VB.NET

public event OnDisconnectedHandler OnDisconnected;

public delegate void OnDisconnectedHandler(object sender, ODataDisconnectedEventArgs e);

public class ODataDisconnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnDisconnected As OnDisconnectedHandler

Public Delegate Sub OnDisconnectedHandler(sender As Object, e As ODataDisconnectedEventArgs)

Public Class ODataDisconnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (OData Component)

This event fires when a document finishes transferring.

Syntax

• C#
• VB.NET

public event OnEndTransferHandler OnEndTransfer;

public delegate void OnEndTransferHandler(object sender, ODataEndTransferEventArgs e);

public class ODataEndTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnEndTransfer As OnEndTransferHandler

Public Delegate Sub OnEndTransferHandler(sender As Object, e As ODataEndTransferEventArgs)

Public Class ODataEndTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Entity Event (OData Component)

This event is fired once for each entity retrieved.

Syntax

• C#
• VB.NET

public event OnEntityHandler OnEntity;

public delegate void OnEntityHandler(object sender, ODataEntityEventArgs e);

public class ODataEntityEventArgs : EventArgs {
  public string Name { get; }
}

Public Event OnEntity As OnEntityHandler

Public Delegate Sub OnEntityHandler(sender As Object, e As ODataEntityEventArgs)

Public Class ODataEntityEventArgs Inherits EventArgs
  Public ReadOnly Property Name As String
End Class

Remarks

The Entity event is fired once for each entity found when retrieving a service's schema (metadata document) through GetSchema.

Entry Event (OData Component)

This event is fired once for each entry retrieved.

Syntax

• C#
• VB.NET

public event OnEntryHandler OnEntry;

public delegate void OnEntryHandler(object sender, ODataEntryEventArgs e);

public class ODataEntryEventArgs : EventArgs {
  public string Id { get; }
  public string Title { get; }
  public string Summary { get; }
  public string ETag { get; }
}

Public Event OnEntry As OnEntryHandler

Public Delegate Sub OnEntryHandler(sender As Object, e As ODataEntryEventArgs)

Public Class ODataEntryEventArgs Inherits EventArgs
  Public ReadOnly Property Id As String
  Public ReadOnly Property Title As String
  Public ReadOnly Property Summary As String
  Public ReadOnly Property ETag As String
End Class

Remarks

The Entry event is fired once for each entry found in the response.

The entry properties are provided through EntryProperties.

The entry links are provided through EntryLinks.

Error Event (OData Component)

Fired when information is available about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, ODataErrorEventArgs e);

public class ODataErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As ODataErrorEventArgs)

Public Class ODataErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (OData Component)

Fired every time a header line comes in.

Syntax

• C#
• VB.NET

public event OnHeaderHandler OnHeader;

public delegate void OnHeaderHandler(object sender, ODataHeaderEventArgs e);

public class ODataHeaderEventArgs : EventArgs {
  public string Field { get; }
  public string Value { get; }
}

Public Event OnHeader As OnHeaderHandler

Public Delegate Sub OnHeaderHandler(sender As Object, e As ODataHeaderEventArgs)

Public Class ODataHeaderEventArgs Inherits EventArgs
  Public ReadOnly Property Field As String
  Public ReadOnly Property Value As String
End Class

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (OData Component)

Fired once for each log message.

Syntax

• C#
• VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, ODataLogEventArgs e);

public class ODataLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As ODataLogEventArgs)

Public Class ODataLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

Remarks

This event is fired once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

Property Event (OData Component)

This event is fired once for each property found within an entity.

Syntax

• C#
• VB.NET

public event OnPropertyHandler OnProperty;

public delegate void OnPropertyHandler(object sender, ODataPropertyEventArgs e);

public class ODataPropertyEventArgs : EventArgs {
  public string Name { get; }
  public string TypeName { get; }
  public bool Nullable { get; }
}

Public Event OnProperty As OnPropertyHandler

Public Delegate Sub OnPropertyHandler(sender As Object, e As ODataPropertyEventArgs)

Public Class ODataPropertyEventArgs Inherits EventArgs
  Public ReadOnly Property Name As String
  Public ReadOnly Property TypeName As String
  Public ReadOnly Property Nullable As Boolean
End Class

Remarks

The Property event is fired once for each property found within an entity after setting SchemaEntityIndex.

SetCookie Event (OData Component)

Fired for every cookie set by the server.

Syntax

• C#
• VB.NET

public event OnSetCookieHandler OnSetCookie;

public delegate void OnSetCookieHandler(object sender, ODataSetCookieEventArgs e);

public class ODataSetCookieEventArgs : EventArgs {
  public string Name { get; }
  public string Value { get; }
  public string Expires { get; }
  public string Domain { get; }
  public string Path { get; }
  public bool Secure { get; }
}

Public Event OnSetCookie As OnSetCookieHandler

Public Delegate Sub OnSetCookieHandler(sender As Object, e As ODataSetCookieEventArgs)

Public Class ODataSetCookieEventArgs Inherits EventArgs
  Public ReadOnly Property Name As String
  Public ReadOnly Property Value As String
  Public ReadOnly Property Expires As String
  Public ReadOnly Property Domain As String
  Public ReadOnly Property Path As String
  Public ReadOnly Property Secure As Boolean
End Class

Remarks

This event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

SSLServerAuthentication Event (OData Component)

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, ODataSSLServerAuthenticationEventArgs e);

public class ODataSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As ODataSSLServerAuthenticationEventArgs)

Public Class ODataSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (OData Component)

Fired when secure connection progress messages are available.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, ODataSSLStatusEventArgs e);

public class ODataSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As ODataSSLStatusEventArgs)

Public Class ODataSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (OData Component)

This event fires when a document starts transferring (after the headers).

Syntax

• C#
• VB.NET

public event OnStartTransferHandler OnStartTransfer;

public delegate void OnStartTransferHandler(object sender, ODataStartTransferEventArgs e);

public class ODataStartTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnStartTransfer As OnStartTransferHandler

Public Delegate Sub OnStartTransferHandler(sender As Object, e As ODataStartTransferEventArgs)

Public Class ODataStartTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Status Event (OData Component)

Fired when the HTTP status line is received from the server.

Syntax

• C#
• VB.NET

public event OnStatusHandler OnStatus;

public delegate void OnStatusHandler(object sender, ODataStatusEventArgs e);

public class ODataStatusEventArgs : EventArgs {
  public string HTTPVersion { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnStatus As OnStatusHandler

Public Delegate Sub OnStatusHandler(sender As Object, e As ODataStatusEventArgs)

Public Class ODataStatusEventArgs Inherits EventArgs
  Public ReadOnly Property HTTPVersion As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").

StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").

Transfer Event (OData Component)

Fired while a document transfers (delivers document).

Syntax

• C#
• VB.NET

public event OnTransferHandler OnTransfer;

public delegate void OnTransferHandler(object sender, ODataTransferEventArgs e);

public class ODataTransferEventArgs : EventArgs {
  public int Direction { get; }
  public long BytesTransferred { get; }
  public int PercentDone { get; }
  public string Text { get; }
  public byte[] TextB { get; }
}

Public Event OnTransfer As OnTransferHandler

Public Delegate Sub OnTransferHandler(sender As Object, e As ODataTransferEventArgs)

Public Class ODataTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property PercentDone As Integer
  Public ReadOnly Property Text As String
  Public ReadOnly Property TextB As Byte()
End Class

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

AtomChannel Type

The information about an Atom feed as it is received from the server.

Remarks

When an Atom feed is parsed by the component, each item is parsed into an AtomEntry type and other information about the feed are presented as AtomChannel.

Fields

Constructors

• C#
• VB.NET

public AtomChannel();

Public AtomChannel()

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

• C#
• VB.NET

public Certificate(byte[] encoded);

Public Certificate(ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

• C#
• VB.NET

public Firewall();

Public Firewall()

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.

Fields

Constructors

• C#
• VB.NET

public Header();

Public Header()

• C#
• VB.NET

public Header(string field, string value);

Public Header(ByVal Field As String, ByVal Value As String)

HTTPCookie Type

An HTTP cookie can be either sent to or received from the server.

Remarks

An HTTP cookie can store the cookies that are to be sent to the server. It also may store the cookies sent by the server.

Cookies that are to be sent to the server must have the Name and Value fields supplied before submitting the URL. When the SetCookie event is fired, however, all of the fields of an HTTPCookie are filled out accordingly.

Fields

Constructors

• C#
• VB.NET

public HTTPCookie();

Public HTTPCookie()

• C#
• VB.NET

public HTTPCookie(string name, string value);

Public HTTPCookie(ByVal Name As String, ByVal Value As String)

ODataEntryLink Type

This is an object representing a single OData entry link.

Remarks

This is an object representing a single OData entry link.

Fields

Constructors

• C#
• VB.NET

public ODataEntryLink();

Public ODataEntryLink()

ODataEntryProperty Type

This is an object representing a single OData entry property.

Remarks

This is an object representing a single OData entry property.

Fields

Constructors

• C#
• VB.NET

public ODataEntryProperty();

Public ODataEntryProperty()

• C#
• VB.NET

public ODataEntryProperty(string name, string value);

Public ODataEntryProperty(ByVal Name As String, ByVal Value As String)

• C#
• VB.NET

public ODataEntryProperty(string name, string value, string type);

Public ODataEntryProperty(ByVal Name As String, ByVal Value As String, ByVal Type As String)

ODataSchemaAssociation Type

This is an object representing a single OData schema navigation property and its corresponding association.

Remarks

This is an object representing a single OData schema navigation property and its corresponding association.

Fields

Constructors

• C#
• VB.NET

public ODataSchemaAssociation();

Public ODataSchemaAssociation()

ODataSchemaEntity Type

This is an object representing a single OData schema entity.

Remarks

This is an object representing a single OData schema entity.

Fields

Constructors

• C#
• VB.NET

public ODataSchemaEntity();

Public ODataSchemaEntity()

ODataSchemaProperty Type

This is an object representing a single OData schema property.

Remarks

This is an object representing a single OData schema property.

Fields

Constructors

• C#
• VB.NET

public ODataSchemaProperty();

Public ODataSchemaProperty()

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

• C#
• VB.NET

public Proxy();

Public Proxy()

• C#
• VB.NET

public Proxy(string server, int port);

Public Proxy(ByVal Server As String, ByVal Port As Integer)

• C#
• VB.NET

public Proxy(string server, int port, string user, string password);

Public Proxy(ByVal Server As String, ByVal Port As Integer, ByVal User As String, ByVal Password As String)

Config Settings (OData Component)

OData Config Settings

HTTP Config Settings

TCPClient Config Settings