Click or drag to resize
Askia

AskiaCore Namespace

Hold the most useful classes and interfaces
Classes
  ClassDescription
Public classContextFactory
Factory to create a IContext to access/edit survey
Public classControlsFactory
Controls factory
Public classLanguageFactory
Language factory
Public classPageTemplatesFactory
Page templates factory
Public classCode examplePersistent
Helper methods to store persistent environment data.
It is important to note that persistent data is only kept in memory despite the name, restarting a process using AskiaCore would clear this data.
Public classQuotaAvailabilityFactory
Public classQuotaFactory
Public classSurveyFactory
Factory to create an instance of ISurvey using the specified context
Public classThemesFactory
Themes factory
Interfaces
  InterfaceDescription
Public interfaceICategory
Public interfaceICategoryCollection
Public interfaceICategoryIterator
Public interfaceICategoryRefCollection
Public interfaceCode exampleIContext
Provide a context for requests execution, it's required for many API requests.
The context is created and its members values are filled by the software using AskiaCore, most of them help identify an entity by providing an id.
Public interfaceIControl
Control interface
Public interfaceIControlCollection
Control collection
Public interfaceIControlCreationResult
Represents the result of methods that creates a control
Public interfaceIControlIterator
Control collection iterator
Public interfaceIControlRender
Represents the result of the control rendering
Public interfaceIDefaultControl
Represents the default control associated to a question type
Public interfaceIDefaultControlCollection
Collection of the extension (ADX) property
Public interfaceIDefaultControlIterator
Iterator over the collection of extension properties
Public interfaceIDynamicSetting
Dynamic setting interface
Public interfaceIElement
Element interface
Public interfaceIElementCollection
Element collection
Public interfaceIElementIterator
Element collection iterator
Public interfaceIError
Error returned by AskiaCore
Public interfaceIExtensionProperty
Represents the key/value pair extension (ADX) property
Public interfaceIExtensionPropertyCollection
Collection of the extension (ADX) property
Public interfaceIExtensionPropertyIterator
Extension properties collection iterator
Public interfaceIInterview
Represents an interview
Public interfaceIInterviewMethodResult
Represents the result of many IInterview methods
Public interfaceIInterviewWebInformation
Information of the web browser doing the interview
Public interfaceILanguage
Language interface
Public interfaceILanguageCollection
Language collection
Public interfaceILanguageIterator
Language collection iterator
Public interfaceILinkedResponse
Linked Response Interface
Public interfaceILinkedResponseCollection
Linked responses collection
Public interfaceILinkedResponseIterator
Linked responses collection iterator
Public interfaceIMergeableResponse
Mergeable response interface
Public interfaceIMergeableResponseCollection
Mergeable response collection
Public interfaceIMergeableResponseIterator
Mergeable response collection iterator
Public interfaceIMergeableSurvey
Mergeable survey interface
Public interfaceCode exampleIMethodResult
Represents the result of a method called
Public interfaceIModifiedEntities
Represents an aggregated lists of all entities that have been modified
Public interfaceIPageRender
Represents the result of the page rendering
Public interfaceIPageTemplate
Page template interface
Public interfaceIPageTemplateCollection
Page template collection
Public interfaceIPageTemplateCreationResult
Represents the result of methods that creates a Page template
Public interfaceIPageTemplateIterator
Page template collection iterator
Public interfaceIQuestion
Question interface
Public interfaceIQuestionCollection
Question collection
Public interfaceIQuestionImportationSettings
Importation Settings Interface
Public interfaceIQuestionIterator
Question collection iterator
Public interfaceIQuestionResult
Represents the result of methods that return a question.
Public interfaceIQuestionsTemplate
Questions template interface
Public interfaceIQuota
Public interfaceIQuotaAllocation
Public interfaceIQuotaAllocationCollection
Public interfaceIQuotaAllocationIterator
Public interfaceIQuotaAvailability
Public interfaceIQuotaAvailabilityCollection
Public interfaceIQuotaAvailabilityDetails
Public interfaceIQuotaAvailabilityDetailsCollection
Public interfaceIQuotaAvailabilityDetailsIterator
Public interfaceIQuotaIssue
Public interfaceIQuotaNode
Public interfaceIQuotaQuestion
Public interfaceIQuotaQuestionCollection
Public interfaceIQuotaQuestionIterator
Public interfaceIQuotaResponse
Public interfaceIQuotaResponseCollection
Public interfaceIQuotaResponseGroup
Public interfaceIQuotaResponseIterator
Public interfaceIQuotaResponseNumeric
Public interfaceIRecordEntitiesOwnerTEntityType
Generic interface for record collections with ownership
Public interfaceIRecordEntity
Represents an entity with a corresponding database entry
Public interfaceIResource
Resource interface
Public interfaceIResourceCollection
Collection of resources
Public interfaceIResourceFile
Resource file interface
Public interfaceIResourceFileCollection
Resource file collection
Public interfaceIResourceFileIterator
Resource file collection iterator
Public interfaceIResourceIterator
Resource collection iterator
Public interfaceIResponse
Response interface
Public interfaceIResponseCollection
Response collection
Public interfaceIResponseIterator
Response collection iterator
Public interfaceIRouting
Routing Interface
Public interfaceIRoutingActionParameter
Routing action parameter Interface
Public interfaceIRoutingCaption
Routing caption Interface
Public interfaceIRoutingCollection
Collection of routings
Public interfaceIRoutingIterator
Routing collection iterator
Public interfaceIRoutingTarget
Routing target interface
Public interfaceIRoutingTargetCollection
Collection of the routing targets
Public interfaceIRoutingTargetIterator
Routing targets collection iterator
Public interfaceIScenario
Scenario interface
Public interfaceIScenarioCollection
Collection of scenarios
Public interfaceIScenarioEntity
Scenario entity interface
Public interfaceIScenarioIterator
Scenario collection iterator
Public interfaceIStructureModificationResult
Represents the result of methods that modified the structure of survey
Public interfaceCode exampleISurvey
Represents a survey
Public interfaceISurveyInformation
Contains basic information about a survey
Public interfaceISurveyIntegrityError
Represents an integrity error within the survey
Public interfaceISurveyResult
Represents the result of methods that return a survey
Public interfaceISurveyTemplate
Survey template interface
Public interfaceITheme
Theme Interface
Public interfaceIThemeProperty
Represents the key/value pair Theme property
Public interfaceIThemePropertyCollection
Collection of the Theme property
Public interfaceIThemePropertyIterator
Theme properties collection iterator
Enumerations
  EnumerationDescription
Public enumerationAllowOverQuotaType
Public enumerationDatabaseTypes
Enumeration of the database types
Public enumerationDynamicSettingType
Enumeration of the Dynamic Settings Types
Public enumerationElementType
Enumeration of the element type
Public enumerationErrorType
Enumeration of error type
Public enumerationInterviewQuotaType
Public enumerationLinkedResponseVisibility
Enumeration of the linked response visibility
Public enumerationQuestionAnonymisationType
Enumeration of the question anonymisation type.
Public enumerationQuestionDateTimeType
Enumeration of the question datetime type
Public enumerationQuestionImportationClosedMatchingType
Enumeration of the question importation type for closed responses
Public enumerationQuestionImportationPanelUpdateType
Enumeration of the question importation update type for panels
Public enumerationQuestionImportationType
Enumeration of the question importation type
Public enumerationQuestionLinkType
Enumeration of the question link type
Public enumerationQuestionRotationType
Enumeration of the question rotation type
Public enumerationQuestionType
Enumeration of the question type
Public enumerationQuestionTypeForDefaultControl
Enumeration of the question type for the default controls
Public enumerationQuestionVisibilityType
Enumeration of the question visibility type
Public enumerationQuotaAvailableType
Public enumerationQuotaIssueType
Public enumerationQuotaLineState
Public enumerationQuotaTargetType
Public enumerationQuotaUpdateType
Public enumerationResourceType
Enumeration of the resource type
Public enumerationResponseBaseType
Enumeration of the response base type
Public enumerationResponseRotationBehaviour
Enumeration of the response rotation behavior
Public enumerationResponseType
Enumeration of the response type
Public enumerationRoutingActionType
Enumeration of the routing action type
Public enumerationRoutingCaptionType
Enumeration of the routing caption type
Public enumerationRoutingConditionType
Enumeration of the routing condition type
Public enumerationRoutingStartType
Enumeration of the possible ways an interview is triggered (i.e. started).
Public enumerationRoutingTargetType
Enumeration of the routing target type
Public enumerationScenarioEntityType
Enumeration of the scenario entity type
Public enumerationScriptErrorType
Enumeration of the AskiaScript error types
Public enumerationSurveyComponent
Public enumerationSurveyIntegrityErrorSeverity
Enumeration of the integrity error severity
Public enumerationSurveyIntegrityErrorType
Enumeration of the survey integrity error types
Public enumerationSurveyMessage
Enumeration of the survey messages
Public enumerationSurveyMilestoneType
Enumeration of the possible values of the RoutingTargetType 'SurveyMilestone'