AskiaCore Factory to create a to access/edit survey Create a new instance of A new context instance \brief %Category interface \brief Name of the category \brief %Category collection \brief Number of categories in the collection \brief Find a category by name \brief Create a category given its name \brief Remove a category from the collection given its id \brief Remove a category from the collection given its name \brief %Category iterator \brief %Category collection \brief Number of categories in the collection \brief Find a category by id \brief Find a category by name \brief Add a category given its id \brief Add a category given its name \brief Remove a category from the collection given its id \brief Remove a category from the collection given its name Provide a context for requests execution, it's required for many API requests. Create a new survey with one question using AskiaCore; namespace MyApp { public class MyProgram { static void Main() { // Initialize the database connection string (Where the survey will be stored) Persistent.InitDatabaseConnection("connectionstring", DatabaseTypes.PORTAL); // Create a new context IContext context = ContextFactory.Create(); context.UserId = 1; context.SessionId = "xxxxx-xxxxx-xxxxx-xxxxxx"; context.LanguageId = 2057; // Edit the survey with this language (English) // Create a new survey ISurvey survey = SurveyFactory.Create(context); survey.Name = "MySurvey"; survey.DefaultLanguageId = 2057; // English // Create the single closed question gender IQuestion gender = survey.Questions.Create(); gender.Shortcut = "gender"; gender.MainCaption ="What's your gender?"; gender.Type = QuestionType.Single; // Create responses IResponse man = gender.Responses.Create(); man.MainCaption = "Man"; IResponse woman = gender.Responses.Create(); woman.MainCaption = "Woman"; // Save all changes survey.SaveAll(); // Release the database connection Persistent.EndDatabaseConnection(); } } } Id of the AskiaPortal user making the request Arbitrary session id in which in the request is made This session id should be the same for all requests made by a client session. It's important to give the same session id for a better management of the undo/redo, logs etc... Id of the current survey language Represents the result of the control rendering Id of the output that has been used Header part of the rendered control Placeholder part of the rendered control Footer part of the rendered control Indicates if the control has been successfully rendered Returns the collection of possible errors \brief Name of the control \brief XML Configuration of the control \brief Data contained within the file \brief Loads the control from a directory \brief Loads the control from a file and extract its content to a directory \brief Loads the control from memory and extracts its content to a directory \brief Renderds the control for a given question of a given survey interview \brief %Control collection \brief Number of controls in the collection \brief Find a control by name \brief Create a control given its name \brief Remove a control from the collection given its id \brief Remove a control from the collection given its name \brief %Control iterator \brief %IControl collection \brief Number of controls in the collection \brief Find a control by id \brief Find a control by name \brief Create a control given its name \brief Remove a control from the collection given its id \brief Remove a control from the collection given its name \brief %IControlsFactory \brief Controls collection \brief Create a new control \brief Enumeration of the element type \brief %Element interface \brief Defines if the Eleemnt is reachable \brief Id of the question related to the element \brief Id of the parent element \brief Parent element \brief Position of the element \brief Type of the element \brief Id of the extension (control or page template) related to the element Set the id of extension depending on the type of the element (Control or Page Template) Id of the control or page template \brief Extension properties collection for the element \brief Theme properties collection for the element \brief HTML code to inject before the element start \brief HTML code to inject after the element start \brief HTML code to inject before the element end \brief HTML code to inject after the element end \brief Classes to add to the element \brief HTML attributes to add to the element \brief Style \brief Gets the caption text for a given language \brief Sets the caption text for a given language \brief Children elements collection for the element \brief Media elements collection for the element \brief Render the corresponding page for the specified interview \brief Render the corresponding control for the specified interview \brief Previous sibling element \brief Previous sibling Id \brief Next sibling element \brief Next sibling Id \brief First child element \brief Last child element \brief %Element collection \brief Number of elements in the collection \brief Get an element with the given id \brief Get the first element with the given type Creates a new child element at a given position Position at which the child element should be created Returns the created entity \brief Remove a element from the collection given its id \brief %Element iterator Enumeration of error type Unknown error Could not find the questionnaire Could not find the control Could not find the page Missing question, could not find the specified question.
TODO::Better explain in which case that occurs TODO::If related to ADX probably prefix it Could not load the specified page template Could not load the specified control Error in AskiaScript Error in AskiaScript
TODO::Better explain in which case that occurs Error in shortcut caption
TODO::Better explain in which case that occurs Possible infinite loop Runtime error.
The AskiaScript compilation succeed but could not be evaluated at runtime Invalid language,
TODO::Better explain in which case that occurs TODO::Maybe the language of the survey Invalid version,
TODO::Better explain in which case that occurs TODO::Maybe the scenario, in that case change the Version to Scenario Could not execute SQL query,
TODO::Better explain in which case that occurs Could no execute the SQL query to import data.
TODO::Better explain in which case that occurs Missing ADX property. Missing ADX content. Invalid ADX file compression.
The zip file is invalid. Invalid ADX config XML file. Invalid ADX Flash file. Could not retrieve the file associated with the ADX content. Invalid ADX config XML definition. Could not find the dynamic file associated with the ADX content. Could not find an ADX output. Error while interpreting the condition of the ADX output. A binary file could not be dynamic in ADX. The `yield` node is require to define how to display arbitrary binary file in ADX. Unable to create the ADX directory. Could not use the `Content.ToText()` method for ADX static/shared files. Missing <askia-head /> tag in the ADX master page. Missing <askia-form> tag in the ADX master page. Missing </askia-form> close tag in the ADX master page. Missing <askia-questions /> tag in the ADX master page. Missing <askia-foot /> tag in the ADX master page. The specified question id is invalid The specified question position is invalid The order of IDs into the range are incorrect Could not move questions or elements Could not indent questions or elements Could not unindent questions or elements Could not save structure modifications The specified element id is invalid The specified element type cannot be moved The specified element move is invalid Error returned by AskiaCore Indicatas the type of the error Internal error code, when available Source context of the error, when available. Start position of the error in the source context when available. Length of the error in the source context Additional information concerning the error Represents the key/value pair extension (ADX) property Name of the property Value assign to the property Tells if the property is inherited or set at the current level Collection of the extension (ADX) property Returns the number of properties in the collection Returns the value associated with the specified property name Name of the property to read Return null if the property was not found Indicates if the collection contains the specified property Name of the property to search True when the collection contains the specified property, otherwize false Create a property using the specified name and value If the name of the property already exist, this method override it's value Name of the property to create Value of the new create property The property that has been created Remove the specified property from the collection Name of the property to remove Returns true if the property was found and removed Remove all properties from the collection Get all properties including the ones resolving to default values Iterator over the collection of extension properties Information of the web browser doing the interview Identity of the web browser // The above string is on a single line // carriage return are only use for readability "name:\"Chrome\", version:\"50.0.2661.102\", os:\"Windows\", mobile:false, tablet:false, userAgent:\"Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/50.0.2661.102 Safari/537.36\", timeOffset:2" Resolution of the web browser's device // The above string is on a single line // carriage return are only use for readability "screen-availWidth:2560, screen-availHeight:1334, screen-width:2560, screen-height:1440, screen-colorDepth:24, window-width:1708, window-height:1130" Browser capabilities // The above string is on a single line // carriage return are only use for readability "Javascript:true, Flash:"21.0.0.0",QuickTime:false,WindowsMediaPlayer:false,Silverlight:false, AdobeReader:false,RealPlayer:false, flexbox:true,flexboxlegacy:true, canvas:true,canvastext:true,webgl:true, touch:false, geolocation:true, postmessage:true, websqldatabase:true,indexeddb:true, hashchange:true,history:true, draganddrop:true, websockets:true, rgba:true,hsla:true, multiplebgs:true,backgroundsize:true, borderimage:true,borderradius:true, boxshadow:true,textshadow:true, opacity:true, cssanimations:true,csscolumns:true,cssgradients:true, cssreflections:true,csstransforms:true,csstransforms3d:true, csstransitions:true, fontface:true,generatedcontent:true, video:true,ogg:true,h264:true,webm:true, audio:true,mp3:true,wav:true,m4a:true, localstorage:true,sessionstorage:true, webworkers:true, applicationcache:true, svg:true,inlinesvg:true,smil:true,svgclippaths:true, autocomplete:true,autofocus:true, list:true,placeholder:true,max:true,min:true, multiple:true,pattern:true,required:true,step:true, search:true,tel:true,url:true,email:true, datetime:false,date:true,month:true,week:true,time:false, datetime-local:true,number:true,range:true,color:true, battery:false,lowbattery:false, cookies:true, bgpositionshorthand:true,bgpositionxy:true,bgrepeatround:false, bgrepeatspace:false,bgsizecover:true, boxsizing:true, csscalc:true,cubicbezierrange:true, display-runin:false,display-table:true, cssfilters:true,csshyphens:false,softhyphens:true,softhyphensfind:true, lastchild:true,cssmask:false, mediaqueries:true,object-fit:true, overflowscrolling:false, pointerevents:true,csspositionsticky:false,cssremunit:true, regions:false,cssresize:true,cssscrollbar:true, subpixelfont:true,supports:true, userselect:false,classlist:true, createelement-attrs:false,datalistelem:true, details:true,outputelem:true, progressbar:true,meter:true,ruby:true, texttrackapi:true,track:true, strictmode:true,devicemotion:true,deviceorientation:true, filereader:true,fileinput:true,formattribute:true, filesystem:true,speechinput:false, formvalidationapi:true,formvalidationmessage:true, formvalidation:true,fullscreen:true, ie8compat:false, json:true,mathml:false,unicode:true, userdata:false,websocketsbinary:true, exif-orientation:false" Represents the result of many methods Indicates if the interview is completed Try to save the answers and to move on the next visible page This method doesn't necesseraly move to the page that follow the current page.
According to the specified parameters, this method could:
- stay on the same page
- go to the previous visible page
- go to the next visible page
 Notice that some routings and properties could redirect the respondent to a previous or to a far next page. Respondent answers and web parameters Returns until a page is accessible Returns the current interview page element Returns the current position of the interview Returns the previous position of the interview Returns the previous interview page element Returns the next possible position of the interview Returns the next possible interview page element Returns the web browser information \brief %Language interface \brief Id of the language \brief LocalName of the language \brief %Language collection \brief Number of languages in the collection \brief Find a language by id \brief Creates a new language in the collection given its name \brief Remove a language from the collection given its id \brief %Language iterator \brief %Language factory \brief Get all existing languages \brief %Media interface \brief Indicates if the media is a system media \brief Name \brief Query \brief Custom properties \brief %Media collection \brief Number of media in the collection \brief Remove a media from the collection given its id \brief %Media iterator \brief Enumeration of the media element units \brief %MediaElement interface \brief Id of the record \brief Last error that occurred \brief Checks if the record is loaded from the database \brief Saves the record \brief ReLoads the record \brief Id of the corresponding element \brief Id of the corresponding media \brief Left margin of the media element in pixel \brief Right margin of the media element in pixel \brief Top margin of the media element in pixel \brief Bottom margin of the media element in pixel \brief Width value of the media element \brief Unit of the media element's width \brief Minimum height of the media element \brief Maximum height of the media element \brief Indicates if the media element is horizontal \brief Specifices the overflow value of the media element \brief Indicates if the media element is hidden \brief Additional styles for the media eleemnts \brief Custom properties for the media element \brief %MediaElement collection \brief Number of media elements in the collection \brief Create a media element given its media id \brief Retrieves the media element associated to the given media id \brief %MediaElement iterator Represents the result of the page rendering Id of the output that has been used Full HTML code of the rendered page (including head, form, foot) Header section of the HTML code of the rendered page Form section of the HTML code of the rendered page Footer section of the HTML code of the rendered page Indicates if the page has been successfully rendered Returns the collection of possible errors \brief Name of the template \brief XML Configuration of the template \brief Data contained within the file \brief Loads the template from a directory \brief Loads the template from a file and extract its content to a directory \brief Loads the template from memory and extracts its content to a directory \brief Renderds the page template for a given question of a given survey interview \brief %IPageTemplate collection \brief Number of templates in the collection \brief Find a template by id \brief Find a template by name \brief Create a template given its name \brief Remove a template from the collection given its id \brief Remove a template from the collection given its name \brief %Control iterator \brief %IPageTemplatesFactory \brief Templaates collection \brief Create a new template \brief Enumeration of the question type \brief Enumeration of the question link type \brief Enumeration of the question rotation type \brief Enumeration of the question visibility type \brief Enumeration of the question importation type \brief Enumeration of the question importation type for closed responses \brief Enumeration of the question importation update type for panels \brief Importation Settings Interface \brief Type of importation \brief TODO \brief TODO \brief TODO \brief TODO \brief TODO \brief TODO \brief Enumeration of the linked response visibility \brief Linked Response Interface \brief Id of the linked response \brief Visibility of the linked response \brief %RoutingTarget collection \brief Number of linked response in the collection \brief Create a linked response given its visibility \brief Remove a linked response from the collection given its responseId \brief %LinkedResponse iterator \brief %Question interface \brief Defines if the Eleemnt is reachable \brief Shortcut of the question \brief The main caption of the question \brief Analyse caption of the question \brief Type of the question \brief Id of the parent question \brief Position of the question \brief Previous sibling question \brief Next sibling question \brief Hack for mo \brief First child question \brief Last child question \brief Indicates if answering the question is mandatory \brief The entry equivalent to a non response \brief Number of digits after decimal point for numeric questions \brief Regular expressions to validate the response of open questions \brief Minimum value for numeric questions Minimum number of characters for open questions \brief Maximum value for numeric questions Maximum number of characters for open questions \brief Minimum number of responses \brief Maximum number of responses \brief Link type of the question \brief Indicaties if links include exclusive responses \brief Id of the linked question \brief Indicates if the link is done on the level \brief Rotation type of the question \brief Seed of the random rotation \brief Id of the associated merged page is there is one \brief Indicates if the question is currently the first one in its page \brief Indicates if the question is currently the last one in its page \brief Indicates if the question is currently either the first or the last one in its page \brief Indicates the visibility type of the question. \brief Indicates if the question is visible in Analyse \brief Indicates if the level is developed in analyse \brief Indicates if the question is scaled \brief Indicates if the question is ranked \brief Indicates if the question is a probability question \brief Indicates if recording could be done on that question (CATI) \brief Indicates that the question should not be translated \brief Potential id of the question to increment \brief IVR Number of the question \brief Data the user can add to the question \brief Element containing the question \brief Page element containing the question \brief Control element of the question \brief Importation settings for this question \brief Move responses to a given destination \brief Move responses to a given destination \brief Indent responses \brief Indent responses \brief Unindent responses \brief Unindent responses \brief Saves all the positions and parent ids of the responses \brief Returns a collection of id of the scenario of this question \brief Add the question to a given scenario \brief remove the question from a given scenario \brief Categories collection for the survey \brief responses collection for the survey \brief retrieve all linked responses recursively based on link type \brief linked responses collection for the survey \brief %Question collection \brief Number of questions in the collection \brief Find a question by name \brief Creates a new question in the collection given its name \brief Creates a new question in the collection given a parent and its name \brief Creates a new question in the collection given a position \brief Creates a new question in the collection given a position and a name \brief Remove a question from the collection given its id \brief Remove a question from the collection given its name \brief %Question iterator \brief %IQuota interface \brief Corresponding Survey \brief Revision number \brief Setting which indicates whether running interviews are taken into account \brief Setting which indicates whether running interviews are taken into account \brief Enable/disable tracking changes - necessary to support GetUpdate \brief Reset all changes \brief Minimum target (count) \brief Maximum target (count) \brief Maximum target (percentage) \brief Set empty maximum target \brief Indicates the maximum target type \brief Count completed interview \brief Count incompleted interviews \brief Count interviews with appointments in quota \brief Count interviews with appointments \brief Count running interviews \brief Count observed interviews (=interviews counted in target) \brief Count available contacts \brief Count available contacts for telephony \brief Count available contacts for web (email) \brief Number of interviews to do to reach minimum target \brief Number of interviews to do to reach minimum target \brief Questions on the root level of the quota tree \brief Process quota update \brief Get quota updates \brief Compare quota tree structure (ignoring settings, version, shortcuts, tokens, etc) \brief Verify the quota structure for sanity issues \brief %Quota factory \brief Create new Quota object \brief %IQuotaAllocation interface \brief Minimum target (count) \brief Minimum target (percentage) \brief Indicates if the minimum target type is in % \brief Maximum target (count) \brief Maximum target (percentage) \brief Indicates if the maximum target type is in % \brief %IQuotaAllocation collection \brief Add a new QuotaAllocation to the collection \brief %IQuotaAllocation iterator \brief %IQuotaAvailability interface \brief Available (count) \brief AvailableNow (count) \brief OVer Callback (count) \brief %IQuotaAvailability collection \brief Find an IQuotaAvailability by index \brief %IQuotaAvailabilityDetails interface \brief Total Available (count) \brief Total AvailableNow (count) \brief Total Over Callback (count) \brief TotalAvailability \brief Total over max calls \brief Array of IQuotaAvailability (array) \brief Token \brief %IQuotaQuestion collection \brief Add a new QuotaAvailabilityDetails to the collection \brief %QuotaAvailabilityDetails iterator \brief %Quota Availability factory \brief Create new Quota Availability object \brief %IQuotaIssue interface \brief Issue code \brief Extra data, meaning depends on the issue code \brief %IQuotaNode interface \brief Main quota object \brief Token of the node \brief Parent node \brief Quota Line state \brief Quota Line state summarized \brief Quota allocations for web brokers \brief Quota allocations for face agents \brief Find a node by token below this one \brief %IQuotaQuestion interface \brief ID of question in survey \brief Type of question in survey \brief Shortcut of question in survey \brief Import of question in survey \brief Import of question in survey \brief Responses in this quota question \brief Add a numeric response to this quota question given the %param name="dRangeMin" and %param name="dRangeMax" for the new range \brief Remove numeric response with token %param name="lToken" from this quota question \brief Add a group to this QuotaQuestion \brief Remove group with token %param name="lToken" from this quota question \brief Move response with token %param name="sourceToken" from this quota question to %param name="targetToken". When succesfull, returns new token \brief %IQuotaQuestion collection \brief Find an IQuotaQuestion by token \brief Add a new QuotaQuestion to the collection Note that this will create a QuotaResponse for all responses as well \brief %IQuotaQuestion iterator \brief %IQuotaResponse interface \brief ID of response in survey \brief short caption of response in survey (in the default language) \brief Minimum target (count) \brief Minimum target (percentage) \brief Set empty minimum target \brief Indicates the minimum target type \brief Maximum target (count) \brief Maximum target (percentage) \brief Set empty maximum target \brief Indicates the maximum target type \brief \brief \brief Count completed interview \brief Count incompleted interviews \brief Count interviews with appointments in quota \brief Count interviews with appointments \brief Count running interviews \brief Count observed interviews (=interviews counted in target) \brief Count available contacts \brief Count available contacts for telephony \brief Count available contacts for web (email) \brief Number of interviews to do to reach minimum target \brief Number of interviews to do to reach minimum target \brief Number of contacts missing to reach the minimum target \brief Questions on the root level of the quota tree \brief %IQuotaResponse collection \brief Find an IQuotaResponse by token \brief \brief \brief \brief \brief Count completed interview \brief Count incompleted interviews \brief Count interviews with appointments in quota \brief Count interviews with appointments \brief Count running interviews \brief Count observed interviews (=interviews counted in target) \brief Count available contacts \brief Count available contacts for telephony \brief Count available contacts for web (email) \brief Number of interviews to do to reach minimum target \brief Number of interviews to do to reach minimum target \brief Number of contacts missing to reach the minimum target \brief %IQuotaResponse iterator \brief %IQuotaResponseGroup interface \brief Group name \brief responses collection for this group \brief %IQuotaResponseNumeric interface \brief Range Minimum \brief Range Maximum Represents an entity with a corresponding database entry Id of the record Id of the user which created the record DateTime the record was created at Id of the user which last updated the record DateTime at which the record was last updated Indicates if the record is flagged as deleted TODO::Change to property instead of method Id of the user which last deleted the record DateTime at which the record was last deleted Checks if the record is loaded from the database Return true when the record was successfully loaded, otherwize return false. In such case refer to the property. Saves the record Return true when the record was successfully saved, otherwize return false. In such case refer to the property. Reloads the record Return true when the record was successfully reloaded, otherwize return false. In such case refer to the property. Deletes the record in the database Return true when the record was successfully deleted, otherwize return false. In such case refer to the property. Restores the deleted record in the database Return true when the record was successfully restored, otherwize return false. In such case refer to the property. Last error that occurred Generic interface for record collections with ownership TODO::Maybe change the name of to IRecordEntityCollection and use a method GetById() instead of the brackets accessor Type of record in the collection Creates a new element Returns the created entity Finds a record entity by id Id of the record entity to find Return the record entity with the specified id or null when not found \brief Enumeration of the resource type \brief %Resource interface \brief Name of the resource \brief Type of the resource \brief collection of the resource files by language \brief Extract the resource to the disk \brief %Resource collection \brief Number of resources in the collection \brief Find a resource by id \brief Find a resource by name \brief Create a resource given its name \brief Remove a resource from the collection given its id \brief Remove a resource from the collection given its name \brief %Resource iterator \brief Indicates if the resource is external \brief Location of the file \brief Data contained within the file \brief %Resource collection \brief Number of resource files in the collection \brief Find a resource file by language id \brief Create a resource file given its language id \brief Removes a resource file given its language id \brief %Control iterator \brief Enumeration of the response type \brief Enumeration of the response base type \brief Enumeration of the response rotation behaviour \brief %Response interface \brief Id of the question \brief Id of the parent response \brief Position of the response \brief Previous sibling response \brief Next sibling response \brief First child response \brief Last child response \brief Type of the question \brief Base type of the response \brief Rotation behaviour of the response \brief Entry code of the response \brief Factor of the response \brief Indicates if the response is exclusive \brief Indicates if the response is selectable \brief Indicates if the response is excluded from translation \brief Id of the resource used by the response \brief Id of the semi=open question for the response \brief User data for the response \brief Gets main caption of the response for the given context \brief Sets main caption of the response for the given context \brief Returns a collection of id of the scenario of this response \brief Add the response to a given scenario \brief Removes the response from a given scenario \brief %Response collection \brief Number of responses in the collection \brief Creates a new response in the collection given its entry code \brief Creates a new response in the collection given a parent and its entry code \brief Creates a new response in the collection given a position \brief Creates a new response in the collection given a position and a entry code \brief Remove a response from the collection given its id \brief %response iterator Represents the result of method called Indicates if the method called was successfully executed Returns the error that has been generated by the called method,
it could be null when the called method succeed ( is true). \brief Enumeration of the routing action type \brief Routing action parameter Interface \brief Name of the parameter \brief Value of the parameter \brief Enumeration of the routing target type \brief Routing target Interface \brief Type of the target \brief Id of the target \brief %RoutingTarget collection \brief Number of routing targets in the collection \brief Create a routing target given its type \brief Remove a routing target from the collection given its targetid \brief Remove a all routing targets \brief %RoutingTarget iterator \brief Enumeration of the routing caption type \brief Routing caption Interface \brief Type of the caption \brief Id of the target \brief %Routing interface \brief Name of the routing \brief Id of the question starting the routing \brief Position of the routing \brief The condition of the routing \brief Action type of the routing \brief Is the routing run if the associated question is not asked \brief Is the routing run before the question \brief Is the routing run during the question \brief Is the routing run after the question \brief Is the routing run during edits \brief Returns a collection of id of the scenario of this routing \brief Add the routing to a given scenario \brief removes the routing from a given scenario \brief Returns a collection of the routing action parameters associated to this filter \brief Returns a collection of the routing targets associated to this filter \brief Returns a collection of the routing captions associated to this filter \brief Compiles the routing ? \brief %Routing collection \brief Number of routings in the collection \brief Find a routing by shortcut \brief Creates a new routing in the collection given its name \brief Remove a routing from the collection given its id \brief Remove a routing from the collection given its name \brief %Routing iterator \brief Enumeration of the scenario entity type \brief %Scenario entity interface \brief Type of the entity \brief Id of the entity \brief %Scenario interface \brief Name of the scenario \brief Description of the scenario \brief Adds an entity to the scenario \brief Removes an entity from the scenario \brief Retrives all the scenario's entities \brief %Scenario collection \brief Number of scenarios in the collection \brief Find a scenario by id \brief Find a scenario by name \brief Create a scenario given its name \brief Create a scenario given its name and its description \brief Remove a scenario from the collection given its id \brief Remove a scenario from the collection given its name \brief %Scenario iterator Enumeration of the survey messages Cannot create a database table A response is expected for question `%q` You can only give one response for question `%q` Response to question `%q` must be numeric Response to question `%q` must be between %1 and %2 Response to question `%q` must be above %1 Response to question `%q` must be under %1 You can only give %1 responses to `%q` You cannot give response `%1` to question `%q` The survey is not loaded The password is incorrect Please specify... Ranking must be between 1 an %1 for question `%q` Rank %1 is missing for question `%q` Rank %1 has been given more than once for question `%q` Other New Other (specify) Don't know You must specify the semi-open response You must specify the semi-open response Please enter a valid date for question `%q` Please enter a valid time for question `%q` The quotas are closed for `%1` ... (text of date picker button) Please select at least %1 for question `%q` Enumeration of the survey integrity error types Undefined error The question within the quota has been deleted The sub-question within the quota has been deleted The response used in the quota has been deleted A reponse has been added in the quota question, but no value has been assigned yet The revision of the survey to update is incompatible with the current survey revision The revision of the survey to update is older than the current survey revision The field from the list file (AskiaField) used by the question importation is not numeric The field from the list file (AskiaField) used by the question importation is not found The question doesn't have a shortcut Duplicate questions shortcut A question loop requires at least one sub-question The survey doesn't have any visible question No screen found in the survey (V5) No screen found for the question (V5) The type of the question has changed The level of the question inside a loop is not compatible with the current survey structure The revision of the survey to update is incompatible with the last revision of the current survey The version of the survey is older and will be upgraded The update source is an old version and the upgrade of the source is required The quota question seems not available The field from the list file (AskiaField) used by the question importation is not textual The field from the AskiaField project used by the question importation is not found The field from the list file (AskiaField) used by the question importation is not date/time The 'Set Charset' routing has been deprecated The type of the question used in the quota has been changed The importation of the question used in the quota has been changed No question The shortcut of the question contains invalid characters The shortcut of the question is a reserved keyword The long caption of the question is missing The question used in the link is missing Link requires a closed question The question used in the link must be defined before the question that uses it The level link must be applied on a loop only The level link must be applied on loops that are on the same level Circular question link reference Quota in loop is not allowed The loop doesn't have any visible question The question doesn't support quota The minimum allowed responses is higher than the maximum allowed The type of question is not defined The type of the loop is not defined No response defined in the closed question Missing response caption Duplicate response caption The response must be exclusive for the specified base type Duplicate response entry code The maximum number of response is invalid (must be higher than 0) The minimum number of responses is higher than the number of responses The start question of the routing is not defined No response selected in the condition of the routing (GUI) The condition of the routing is empty Script error The condition of the routing must be a number and not an array The condition of the routing must be a number The type of the routing condition is not defined (GUI) The value of the routing condition is not defined (GUI) The minimum value of the routing condition is higher than the maximum value (GUI) The execution time (before/during/after...) of the routing is not defined The target question of the routing is not defined The target question of the routing is not within the same loop The output code of the routing to abandon the interview is invalid The message of the routing is not defined The responses to ignore are not defined Cannot set the value of the target question (chapter or question within a loop) Missing DSN for the `run SQL Query` routing Missing query for the `run SQL Query` routing Missing program path for the `run program` routing Missing language for the `set language` routing Missing `to` field for the `send email` routing Missing `from` field for the `send email` routing Missing scenario for the `set scenario` routing Missing file prefix for the `start recording` routing The action of the routing is not defined The container element of the question is missing Invalid number of elements in the container element Enumeration of the integrity error severity Undefined severity Low severity, the survey is usable but contains minor errors Medium severity, the survey is usable but could generate unexpected behaviours High severity, the survey is usable but could generate interview errors Critical severity, the survey is not usable Enumeration of the AskiaScript error types No error Represents an integrity error within the survey Type of the error Severity of the error Id of the object causing the error when available Name of the object causing the error when available Id of the parent of the object causing the error when available Name of the parent of the object causing the error when available Type of the AskiaScript error when available Represents an aggregated lists of all entities that have been modified Get the list of questions that have been modified Get the list of elements that have been modified Get the list of responses that have been modified Represents the result of methods that modified the structure of survey Returns the list of entities that has been modified by the called method Represents a survey The survey instance is created for a given context.
You can have multiple instances representing the same survey with different contexts,
they all will internally interact with the same reference of the survey data. The concurrent management of survey with context is mostly done to allows edition by multiple users at the same time on the same survey. Use two different survey instances to manipulate the same survey data using AskiaCore; namespace MyApp { public class MyProgram { static void Main() { // Initialize the database connection string (Where the survey will be stored) Persistent.InitDatabaseConnection("connectionstring", DatabaseTypes.PORTAL); // Create a context with the user 1 IContext contextA = ContextFactory.Create(); contextA.UserId = 1; contextA.SessionId = "xxxxx-xxxxx-xxxxx-xxxxxx"; contextA.LanguageId = 2057; // Edit the survey with this language (English) // Get the survey with the AskiaPortal id 1 // and with the contextA ISurvey surveyWithContextA = SurveyFactory.Get(contextA, 1); IQuestion ageContextA = surveyWithContextA.Questions["age"]; Console.WriteLine(ageContextA.Responses.Count); // -> Output: 4 // Create a context with the user 2 IContext contextB = ContextFactory.Create(); contextB.UserId = 2; contextB.SessionId = "yyyyy-yyyyy-yyyyy-yyyyy"; contextB.LanguageId = 1036; // Edit the survey with this language (French) // Get the survey with the AskiaPortal id 1 // and with the contextB ISurvey surveyWithContextB = SurveyFactory.Get(contextB, 1); IQuestion ageContextB = surveyWithContextB.Questions["age"]; IResponse response ageContextB.Responses.Create(); response.MainCaption = "50+"; // Save all changes using the context B surveyWithContextB.SaveAll(); // The survey with the context A and the survey with the context B // are both up-to-date with the additional response Console.WriteLine(ageContextA.Responses.Count); // -> Output: 5 Console.WriteLine(ageContextB.Responses.Count); // -> Output: 5 // Release the database connection Persistent.EndDatabaseConnection(); } } } Id of the survey in AskiaPortal database Name of the survey Description of the survey Promotes teh current survey to a survey Template Id of the survey default Language If not specified the default language will be English (2057) Returns the id of the survey default page template Gets the version of the engine that created the survey Set the default pages template id for the whole survey Valid page template id Return the result of the operation Move questions to a given destination This method automatically saves the modifications in the database TODO Movement rules Ids of questions to move Id of the parent target question Position at which the questions will be moved as the parent target child Return the result of the movement Indent questions This method automatically saves the modifications in the database TODO Indent rules Ids of questions to indent Return the result of the indent Unindent questions This method automatically saves the modifications in the database TODO Indent rules Ids of questions to unindent Return the result of the unindent Merge questions from the given id's range into the same page This method automatically saves the modifications in the database TODO Merge rules First id of the question range to merge Last id of the question range to merge Return the result of the merge Split merged questions from the given id's range This method automatically saves the modifications in the database TODO Split rules First id of the question range to split Last id of the question range to split Return the result of the split Move element to a given destination This method automatically saves the modifications in the database TODO Movement rules Id of the element to move Id of the parent target element Position at which the element will be moved as the parent target child Return the result of the movement \brief Saves all the survey recursively \brief Saves to file in exchange format (.qex) \brief Saves to file in exchange format (.qex) \brief Saves to memory in exchange format (.qex) \brief Reads from file in exchange format (.qex) \brief Reads from file in exchange format (.qex) \brief Reads from memory in exchange format (.qex) \brief Saves to file in XML format \brief Saves to memory in XML format (.qex) \brief Reads from file in XML format \brief Reads from memory in XML format \brief Checks the questions structure \brief Checks the routings \brief Checks the elements structure \brief Checks all the survey (basically calls all other check functions) \brief extract resources to their apropriate location (see persistent) \brief checks if the given resource file location already exist \brief Creates an interview from this survey \brief Languages collection for the survey \brief Scenarios collection for the survey \brief Categories collection for the survey \brief Resources collection for the survey \brief Questions collection for the survey \brief Retrieve a response from within the questions of the survey given its id \brief Retrieve responses from within the questions of the survey given their ids \brief Routings collection for the survey \brief Elements collection for the survey \brief Media collection for the survey \brief Controls collection for the survey \brief Page templates collection for the survey \brief Extension properties collection for the survey \brief Theme properties collection for the survey \brief Returns a collection of the messages for the current language This class is used to dynamically instantiate and call the methods on the internal AskiaCore implementation assembly. It takes care of the 32/64bit environment Return the type of the specified string Type to obtain as string Return the type object from the specified string or null Dynamically create an object from the specified class with the specified constructor parameters Name of the class object to instantiate List of parameters to instantiate the class Return the instance of the class or null Dynamically create an object from the specified class with the specified constructor parameters Name of the class object to instantiate List of parameters to instantiate the class Return the instance of the class or null Dynamically invoke a specified static method of the specified class with the specified parameters Name of the class object to use Name of the method to invoke List of parameters to invoke the static method Return the instance of the class or null \brief Generates a survey from this template Represents the key/value pair Theme property Name of the property Value assign to the property Tells if the property is inherited or set at the current level Collection of the Theme property Returns the number of properties in the collection Returns the value associated with the specified property name Name of the property to read Return null if the property was not found Indicates if the collection contains the specified property Name of the property to search True when the collection contains the specified property, otherwize false Create a property using the specified name and value If the name of the property already exist, this method override it's value Name of the property to create Value of the new create property The property that has been created Remove the specified property from the collection Name of the property to remove Returns true if the property was found and removed Remove all properties from the collection Get all properties including the ones resolving to default values Iterator over the collection of Theme properties Enumeration of the database types Use DAO access database Use ODBC access database Use ADO access database Use AskiaPortal database Helper methods to store persistent environment data For .NET web project you may use the Global.asax to initialise the persistent settings Management of the database connection in the Global.asax of the .NET web project using AskiaCore; namespace MyApp { public class Global : HttpApplication { protected void Application_Start(object sender, EventArgs e) { // Initialize the database connection string (Where the survey was stored) Persistent.InitDatabaseConnection("connectionstring", DatabaseTypes.PORTAL); // Initialize the /Resources folder Path and URL Persistent.ResourcesPath = "C:\\Inetpub\\wwwroot\\MyApp\\Resources\\"; Persistent.ResourcesUrl = "/Resources/"; } protected void Application_End(object sender, EventArgs e) { // Release the database connection Persistent.EndDatabaseConnection(); } } } Full physical path to the /Resources directory URL (relative) to the /Resources directory Initializes the ASP.NET context for dll loading. This exists so the inner native dll AskCmnu.dll can be loaded in an ASP application without putting it in a system folder Initializes the connection to the database For .NET web project you may use the Global.asax to initialise the database connection Initialise the database connection in the Global.asax of the .NET web project using AskiaCore; namespace MyApp { public class Global : HttpApplication { protected void Application_Start(object sender, EventArgs e) { // Initialize the database connection string (Where the survey was stored) Persistent.InitDatabaseConnection("connectionstring", DatabaseTypes.PORTAL); } } } Connection string or path for the database, depending on the database type Type of the database to use Closes the database connection For .NET web project you may use the Global.asax to release the database connection Release the database connection in the Global.asax of the .NET web project using AskiaCore; namespace MyApp { public class Global : HttpApplication { protected void Application_End(object sender, EventArgs e) { // Release the database connection Persistent.EndDatabaseConnection(); } } } Initializes the connection to the webprod database For .NET web project you may use the Global.asax to initialise the database connection Initialise the database connection in the Global.asax of the .NET web project using AskiaCore; namespace MyApp { public class Global : HttpApplication { protected void Application_Start(object sender, EventArgs e) { // Initialize the database connection string Persistent.InitWebProdDatabaseConnection("connectionstring"); } } } Connection string or path for the database access, depending on the database type Closes the webprod database connection For .NET web project you may use the Global.asax to release the database connection Release the database connection in the Global.asax of the .NET web project using AskiaCore; namespace MyApp { public class Global : HttpApplication { protected void Application_End(object sender, EventArgs e) { // Release the database connection Persistent.EndWebProdDatabaseConnection(); } } } Factory to create an instance of using the specified context Create a new blank survey Create a new survey using AskiaCore; namespace MyApp { public class MyProgram { static void Main() { // Initialize the database connection string (Where the survey will be stored) Persistent.InitDatabaseConnection("connectionstring", DatabaseTypes.PORTAL); // Create a new context IContext context = ContextFactory.Create(); context.UserId = 1; context.SessionId = "xxxxx-xxxxx-xxxxx-xxxxxx"; context.LanguageId = 2057; // Edit the survey with this language (English) // Create a new survey ISurvey survey = SurveyFactory.Create(context); survey.Name = "MySurvey"; survey.DefaultLanguageId = 2057; // English // ... Rest of the code to create questions // Save all changes survey.SaveAll(); // Release the database connection Persistent.EndDatabaseConnection(); } } } Context used to create the survey A new created survey instance Ger an instance of an existing survey Create a new survey with one question using AskiaCore; namespace MyApp { public class MyProgram { static void Main() { // Initialize the database connection string (Where the survey was stored) Persistent.InitDatabaseConnection("connectionstring", DatabaseTypes.PORTAL); // Create a new context IContext context = ContextFactory.Create(); context.UserId = 1; context.SessionId = "xxxxx-xxxxx-xxxxx-xxxxxx"; context.LanguageId = 2057; // Edit the survey with this language (English) // Get the survey with the AskiaPortal Id = 1 ISurvey survey = SurveyFactory.Get(context, 1); if (survey == null) { Console.WriteLine("[ERROR] Could not find the survey with the AskiaPortal id 1"); } else { Console.WriteLine("The name of the survey 1 is `{0}`", survey.Name); } // Release the database connection Persistent.EndDatabaseConnection(); } } } Context used to access the survey Id (from AskiaPortal database) of the survey to access The instance of survey or null if not found \brief SurveyTemplates collection Clears the cached surveys so they can be reloaded on the next call to