WebReports.Api

Api Class

The Api class is the main interaction class between Exago and the host application. All API session parameters are accessed through this class.

NOTE. An Api object should be the first thing that is created to interact with Exago.

 

An Api object has the following properties:

 

An Api object has the following methods:

 

Constructor( )

Remark

Do not call this method from the .NET Api.

 

Constructor(string appVirtualPath)

Description

Initializes an Api object and sets the AppVirtualPath.

Remarks

Return value is void.

 

Constructor(string appVirtualPath, string configFile)

Description

Initializes an Api object, sets the AppVirtualPath and loads the specified configuration.

Remarks

Can be used to load configuration other than WebReport.xml.

Return value is void.

 

Constructor(string appVirtualPath, string configFile, string azurePath)

Description

Initializes an Api object, sets the AppVirtualPath and loads the specified configuration from Azure.

Remarks

The specified Azure path must match that is app.config in the Exago installation. See Azure Cloud Support for more information.

Return value is void.

 

GetUrlParamString( )

Description

Calls GetUrlParamString(“ExagoHome”)

Remarks

Return value is void.

 

GetUrlParamString(string webPageName)

Description

Returns the URL parameter string used to redirect browser or frame to Exago. Append this string to your Exago URL.

 

GetUrlParamString(string webPageName, boolean showErrorDetail)

Description

Returns the URL parameter string used to redirect browser or frame to Exago.   Append this string to your Exago URL. Set showErrorDetail to True to display detailed error messages.