Index Classes
CapeSoft Logo

CapeSoft NetTalk
DNS

Download Latest Version
Installed Version Latest Version

NetTalk DNS

Introduction

The Domain Name System (DNS) is the giant, global, database of names that translate human text names (like say capesoft.com) into IP addresses.

NetTalk contains some utility functions for reading DNS values from the "global database". These are documented on the Utility Functions page.

NetTalk also contains a NetDNS class which is used as a client, to Domain Name Service providers. This document serves to document that class.

This class allows you to add, read, edit and remove Domain Name records from the DNS database. Not all service providers provide an API though. This class currently works with the following providers;
To make use of this class you will need to have a domain registered with one of the providers listed above. Additional providers can be added, and derived classes are easily added to the system.

This class is included with all levels of NetTalk, including NetTalk Desktop.

Examples

App Description
\Demo\ABC An ABC Template based interactive program that exercises methods in the NetDNS Class.
\Demo\Legacy A Clarion Template based interactive program that exercises methods in the NetDNS Class.
\apiServer\DnsApi Source code to the NetTalk DNS API Server.
\apiClient\DnsApiClient An example program which talks to the NetTalk DNS API server and retrieves a certificate. This example is useful for testing the API, but also for fetching certificates generated by the API server. This program is not needed for Web Servers implementing the API Challenge Certificate method, however it allows for certificates to be fetched from other machines if the server machine is not able to reach the internet. (In other words it allows you to get a certificate for the domain from a completely unrelated machine.)

Class Reference

NetDnsBase

NetDns is based on the NetWebClient class. So all the properties and methods there are in scope. This class behaves as a WebClient, talking to the DNS Server API.

Typically the base class is not used directly as an object. Rather one of the derived provider classes are used (for example NetDnsDNSimple.) However the functionality is described in the base class, as this functionality is inherited by all the derived classes.

Derivation

  • NetDnsBase ( NetDNS.Inc / NetDNS.Clw )

Properties

Property Description
AuthMethod (Long) Sets the Authorization method used when talking to the DNS Service Provider. Defaults to Net:WebBasicAuthentication. 
BaseURL (Cstring) This is the root URL of the testing, or production, DNS API Server. It is typically set by the derived class. It is then used when calling all the specific API calls.
Json (JsonClass) A utility JSONCLASS object that is provided for derived classes to use. It is useful as most services use JSON in their API calls.
State (Long) When talking to a service, when a request is sent, then the State is set. When a reply is received then the correct Parse method is called, based on the request that was made. After parsing the state may be set back to ndns:ready, indicating that the object is doing nothing.
Testing (byte) Some services have a testing server, and a production server. If this property is true then the testing server is used in the BaseURL, and if false then the BaseURL is set to the production server.

Methods

Method Description
ErrorTrap
GetAccounts / ParseGetAccounts
Host
ListDomains / ParseListDomains
PageReceived


SetHeaders
Start


WhoAmI / ParseWhoAmI


DNS Records
DeleteRecordByName
WriteRecord
CheckRecord


NetDnsDNSimple

Derivation

Properties

This class inherits all the properties of the NetDnsBaseClass, but has no properties of it's own.

Methods

This class derives methods defined in the NetDnsBaseClass, with code specific to the DNSimple service provider. It has no additional methods.
[End of this document]
Return to NetTalk Documentation Index