C# Class ScrewTurn.Wiki.Plugins.PluginPack.UnfuddleTickets

Implements a formatter that display tickets from Unfuddle.
Inheritance: IFormatterProviderV30
Show file Open project: mono/ScrewTurnWiki

Public Methods

Method Description
Format ( string raw, ContextInformation context, FormattingPhase phase ) : string

Performs a Formatting phase.
Init ( IHostV30 host, string config ) : void

Initializes the Storage Provider.

If the configuration string is not valid, the methoud should throw a InvalidConfigurationException.

PrepareTitle ( string title, ContextInformation context ) : string

Prepares the title of an item for display (always during phase 3).
Shutdown ( ) : void

Method invoked on shutdown.

This method might not be invoked in some cases.

Private Methods

Method Description
BuildXmlFromApiCalls ( ) : XmlDocument

Builds 3 Xml Documents, the first two are lookups for Milestone, and People information, the second is the ticket information.
FindAndRemoveFirstOccurrence ( StringBuilder buffer ) : string>.KeyValuePair

Finds and removes the first occurrence of the custom tag.
GetXml ( string Url, string Username, string Password ) : XmlDocument

Produces an API call, then returns the results as an Xml Document
LoadUnfuddleTicketsFromWeb ( ) : string

Builds an xml document from API calls to Unfuddle.com then runs them through an Xslt to format them.
LogWarning ( string message ) : void

Logs a warning.

Method Details

Format() public method

Performs a Formatting phase.
public Format ( string raw, ContextInformation context, FormattingPhase phase ) : string
raw string The raw content to Format.
context ScrewTurn.Wiki.PluginFramework.ContextInformation The Context information.
phase FormattingPhase The Phase.
return string

Init() public method

Initializes the Storage Provider.
If the configuration string is not valid, the methoud should throw a InvalidConfigurationException.
public Init ( IHostV30 host, string config ) : void
host IHostV30 The Host of the Component.
config string The Configuration data, if any.
return void

PrepareTitle() public method

Prepares the title of an item for display (always during phase 3).
public PrepareTitle ( string title, ContextInformation context ) : string
title string The input title.
context ScrewTurn.Wiki.PluginFramework.ContextInformation The context information.
return string

Shutdown() public method

Method invoked on shutdown.
This method might not be invoked in some cases.
public Shutdown ( ) : void
return void