Preliminary Developer Documentation

Please note that our developer documentation is not yet complete as the API is still somewhat of a moving target.  Any documentation you see here is subject to change - please check this knowledgebase entry for any API changes before updating to later versions.

=== API QuickRef as at v1.0.15 ===

• All Time Service Providers (TSPs) are required to be .NET Class Libraries.  A sample project can be downloaded.
• TSPs may not be obfuscated or otherwise encrypted (or the Service Handler may not be able to identify them).
• A TSP must contain at minimum a single class named <Application>Service, which implements the interface FusionDigital.Chronicle.Services.ITimeService.  See the XmlDoc for more info.
• As a general rule, we don't like TSPs to display any UI.  However, nothing physically prevents this and sometimes it is necessary (e.g. for oAuth logins).
• It is recommended if you intend to make HTTP requests to use the FusionDigital.Chronicle.Services.ChronicleHttpWebRequest class rather than the built-in HttpWebRequest as the Fusion Digital provided class will attempt to handle situations like proxy authentication which the Microsoft class will not.
• TSPs should not attempt to handle their own configuration.  Chronicle's UI saves the configuration by means of serialising a configured instance of your class to disk.
• TSPs are only loaded from the "\Services" subdirectory underneath the Chronicle application folder at this time.  Future versions may also load from a user-specific location.

=== Impending Changes in v1.1.0 ===

• TSPs claiming to be published by "Fusion Digital Entertainment Limited" will require to be digitally signed with Fusion Digital's Software Publisher Certificate.  Providers not claiming to be published by us will not need to be.
• API documentation for v1.0.x versions of Chronicle will no longer apply.

Updated Saturday November 7, 2009 @ 15:04 NZST