AskiaPortalCmnApi Class

Entry point of the current API.

Define and get information about the application context.
It indicates in which context the AskiaPortalCmn API is currently running.

Inheritance Hierarchy

SystemObject
AskiaPortalCmnAskiaPortalCmnApi

Namespace: AskiaPortalCmn
Assembly: AskiaPortalCmn (in AskiaPortalCmn.dll) Version: 1.7.0-build068

Syntax

public static class AskiaPortalCmnApi

Public NotInheritable Class AskiaPortalCmnApi

public ref class AskiaPortalCmnApi abstract sealed

The AskiaPortalCmnApi type exposes the following members.

Properties

	Name	Description
	CurrentModule	Gets the module currently using the API
	CurrentModuleGuid	Obsolete. Gets the GUID of the module currently using the current API
	CurrentModuleVersion	Obsolete. Gets the version of the module currently using the current API
	CurrentProgramName	Gets the name of the program that is currently using the API

Methods

	Name	Description
	InitializeModule	Indicates which module is currently using the API.
	RegisterInitEvent	Register on init event
	Validate	Indicates if the API application context is valid. Check if the current module has been initialized.
	ValidateAndThrow	Same method than Validate, but throw the exception if the API application context is not valid.

Events

	Name	Description
	OnSetup	Event raise when the module must be registered or updated according to the current assembly version.

Fields

	Name	Description
	MinimalCompatibleDatabaseVersion	Minimal version of the database compatible with the current API.

Remarks

This is the entry-point of the application.

API developers must call the method InitializeModule(Guid, Version, String, Boolean) before using the rest of the API.