AskiaPortalCmn Namespace

Hold the most useful classes and interfaces

Classes

	Class	Description
	ApplicationFactory	Factory of AskiaPortal applications.
	AskiaPortalCmnApi	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.
	AskiaPortalInstanceFactory	Factory to manage AskiaPortal Instance and all related licenses.
	ContextFactory	Factory to create a new context of execution A context of execution is almost require to instantiate all objects. Consider the creation of context the entry point of the AskiaPortalCmn usage. According to the AuthenticationType of the context, the API will be restricted. For example, a context created for registration (ForRegistration) will only allow the creation of a new user and send to him email(s) to activate the user account.
	EmailFactory	Factory of AskiaPortal emails
	Events	Represent an AskiaPortal log
	EventsFilters	Class represents the selective criteria to be used to find the log(s) in the database. There is a method Find which takes an IContext and a List of EventFilters as arguments, and it returns a List of all found logs, in a LogPoco format. The number of arguments is not limited as well as a number of the returned logs.
	GroupFactory	Factory of AskiaPortal group of users
	InvalidItemFactory	Factory of AskiaPortal invalid items.
	LanguageFactory	Factory of AskiaPortal languages
	MatchItem	Specify a condition used to filter the incoming messages (Key: "entity", ExpectedValue: "survey")
	MessageQueueFactory	Factory of Message Queue.
	ModuleFactory	Factory of AskiaPortal modules
	ReturnValue	Standard return value for methods which provide exception information.
	ReturnValueT	Generic version of the IReturnValue.
	ServerFactory	Factory of servers.
	ShareFactory	Factory of AskiaPortal shares
	ShareQueryFilter	Filters to query the list of shares.
	SurveyFactory	Factory of AskiaPortal surveys.
	TranslatorFactory	Factory of AskiaPortal translator
	UserFactory	Factory of AskiaPortal users
	UserProfileFactory	Factory of AskiaPortal user profiles.
	UserTokenFactory	Factory of AskiaPortal user tokens.

Interfaces

	Interface	Description
	IApplication	Manage an AskiaPortal application.
	IApplicationBase	Base interface of application.
	IAskiaPortalInstance	AskiaPortal instance information.
	IAskiaPortalInstanceData	AskiaPortal instance data.
	IContext	Provide the context of execution.
	ICurrentLicensesUsage	Manage the current licenses usage (current month).
	IEmail	Manage an AskiaPortal email
	IEmailBase	Base interface of email.
	IEmailTranslation	Email message for a specific language
	IEmailTranslationBase	Base interface of email translation.
	IEmailTranslations	Manage all translations of an email
	IGroup	Manage an AskiaPortal group of users
	IGroupBase	Base interface of group
	ILanguage	Manage an AskiaPortal language
	ILanguageBase	Base interface of language.
	ILicense	License data.
	ILicensesUsage	Provide the licenses usage information.
	ILicensesUsagePerMonth	Provide the licenses usage information for a month.
	ILog	Represent a log entry.
	ILogger	Manage the writing of different types (system or activity) of logs.
	IManagedGroups	Accessor to the list of groups managed by the user
	IMessageContainer	Container of the message within the queue.
	IMessageQueue	Interface that is used for message sending and receiving from a message broker.
	IMessageQueueFilter	Specify some filters used by the message broker in the message routing
	IModule	Manage an AskiaPortal module
	IReturnValue	Standard return value for methods which provide exception information.
	IReturnValueT	Generic version of the IReturnValue.
	IServer	Manage an server application.
	IServerBase	Base interface of server.
	IShare	Manage an AskiaPortal share
	IShareRule	Represent a calculate share rule.
	ISurvey	Manage an AskiaPortal survey.
	ISurveyBase	Base interface of survey.
	ISurveyServerMapItem	Manage a map item between a survey and a server.
	ITranslation	Translation accessible through ITranslator.
	ITranslator	Translator of a specified language
	IUser	Manage an AskiaPortal user
	IUserBase	Base interface of user.
	IUserProfile	Manage a user profile.
	IUserProfileBase	Base interface of user profile.
	IUserResource	Manage a user resource.
	IUserToken	Manage a user token.
	IUserTokenBase	Base interface of user token.

Enumerations

	Enumeration	Description
	AccessLevel	Possible level of permission accessibility.
	AccessTo	Possible `AskiaPortal` access permissions.
	AuthenticationType	Type of authentication.
	ConnectionStringType	Possible type of connection string.
	ContactType	Possible type of contact.
	EncryptedKeyAction	Encrypted key to perform certain action.
	EventLevel	Enumerates all event levels
	EventType	Enumerates all the event types.
	InvalidItemKey	Possible `AskiaPortal` invalid items.
	LicenseType	Enumerates the type of the licenses
	MatchItemKeys
	ModuleCategory	Enumerates all possible modules category
	ModuleState	Possible states of a module
	ModuleUrlTo	Possible URLs of a module
	PermissionTo	Possible `AskiaPortal` boolean permissions.
	ResourceFormat	Resource format
	ShareObjectType	Possible `AskiaPortal` shareable object type.
	SurveyState	Possible states of a survey
	UserState	Possible states of a user account.