[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 1040 > < TAKE 992 >
137 items
DocFragId | Assembly | DocFragType | Description.FirstLine() |
---|---|---|---|
ARCQuery.QueryProgressP | ARCQuery | Enum | Describes class -QueryProgress-. |
ARCAPI.AddController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCAPI.DataStorage.DocLinks | ARCAPI | ClassMember | Note that may be null. |
ARCQuery.QueryProgressP.Title | ARCQuery | EnumMember | The title to be used in the final presentation of the query result. |
ARCAPI.AddController.AllowFilter | ARCAPI | ClassMember | Describes what data is allowed to change through a list of -Subscription- instances. |
ARCAPI.DataStorage.Lock | ARCAPI | ClassMember | Locking object for thread-safe access from simultaneous API requests. |
ARCQuery.QueryProgressP.Queries | ARCQuery | EnumMember | |
ARCAPI.BaseController | ARCAPI | Class | Contains basic functionality for serving API methods. |
ARCAPI.DataStorage.ExternalReceiver | ARCAPI | ClassMember | Typically used by -AddController-. |
ARCQuery.QueryProgressP.StrCurrentType | ARCQuery | EnumMember | Normally the -ToStringVeryShort- representation of the type of objects in the -Result- collection. |
ARCAPI.BaseController.BuildControllerStorage | ARCAPI | ClassMember | Builds a collection of 'std' (standard) controller instances to use for serving API requests. |
ARCAPI.DataStorage.DoNotStoreInternally | ARCAPI | ClassMember | Typically used by -AddController-. |
ARCQuery.QueryProgressP.CurrentStrictness | ARCQuery | EnumMember | Describes -Strictness- ON / OFF when executing query. |
ARCAPI.BaseController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
ARCAPI.BaseControllerP | ARCAPI | Enum | Describes class -BaseController-. |
ARCQuery.QueryProgressP.CreateHints | ARCQuery | EnumMember | Describes if hints are to be generated (as query progresses) for new queries. |
ARCAPI.BaseController.CatchAll | ARCAPI | ClassMember | Serves the typical single generic API method in an AgoRapide API. |
ARCAPI.BaseControllerP.CountRequest | ARCAPI | EnumMember | Number of calls to -APIMethod- since application initialization |
ARCQuery.QueryProgressP.UseCache | ARCQuery | EnumMember | Describes if cache is to be used or not. |
ARCAPI.BaseController.TryNavigateToLevelInDataStorage | ARCAPI | ClassMember | Navigates to the specified level (usually within -Storage-). |
ARCAPI.BaseControllerP.CountException | ARCAPI | EnumMember | Number of exceptions at call to -APIMethod- since application initialization |
ARCQuery.QueryProgressP.LinkAdjustment | ARCQuery | EnumMember | Experimental: Adjustment to be done by -QueryProgress-.- ToHTMLSimpleSingle- (when it ascertains how to go back to root level). |
ARCAPI.BaseController.GetFormatAndAdjustRequest | ARCAPI | ClassMember | Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on). |
ARCAPI.BaseControllerP.LogLevel | ARCAPI | EnumMember | |
ARCQuery.QueryProgressP.Limit | ARCQuery | EnumMember | Limits the final HTML presentation of results (limits the number of elements being presented). Does not affect the query in itself. Used in order to avoid building huge HTML pages which will not be consumed anyway. |
ARCAPI.BaseController.GetTimestampIsOldWarningHTML | ARCAPI | ClassMember | If -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format. |
ARCAPI.ResponseFormat | ARCAPI | Enum | The response format, HTML or JSON, for an API request. |
ARCQuery.QueryProgressP.TerminateReason | ARCQuery | EnumMember | The reason for a query being terminated. This property should contain a user friendly message about the problem and how to fix it. |
ARCAPI.BaseController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCAPI.ResponseFormat.JSON | ARCAPI | EnumMember | |
ARCQuery.QueryProgressP.AllLogEntriesForThisQuery | ARCQuery | EnumMember | |
ARCAPI.EditController | ARCAPI | Class | Offers a simple HTML editing environment of the raw -PropertyStream- from the given key. |
ARCAPI.ResponseFormat.HTML | ARCAPI | EnumMember | |
ARCQuery.TranslationsP | ARCQuery | Enum | This enum has no values because the keys are the actual string to be translated. |
ARCAPI.EditController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
Assembly AgoBrowse | Assembly | ||
ARCQuery.TranslationSingleP | ARCQuery | Enum | Describes class -TranslationSingle-. |
ARCAPI.EditController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
AgoBrowse.Program | AgoBrowse | Class | |
ARCQuery.TranslationSingleP.Text | ARCQuery | EnumMember | |
ARCAPI.GQController | ARCAPI | Class | Offers GraphQL queries. |
AgoBrowse.Program.InitStreamProcessor | AgoBrowse | ClassMember | Initializes stream processor. |
ARCQuery.TranslationSingleP.IsMissing | ARCQuery | EnumMember | Value TRUE indicates that the Text given is simply the original key, in other words, the translation for the key is actually missing. |
ARCAPI.GQController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
AgoBrowse.Root | AgoBrowse | Class | Contains the user friendly welcome text (front page) for the application. |
ARCQuery.EntityMethodKey+MethodType | ARCQuery | Enum | Explains type of method signature found (trough reflection) for corresponding entity class. |
ARCAPI.GQController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
AgoBrowse.Root.ToHTMLSimpleSingle | AgoBrowse | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
ARCQuery.EntityMethodKey+MethodType.Simple | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)' |
ARCAPI.RQController | ARCAPI | Class | RQ = REST Query. Executes a REST like query request against the given -DataStorage-. |
ARCQuery.EntityMethodKey+MethodType.Complex | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)' |
ARCAPI.RQController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
ARCQuery.QueryExpressionWhere+WildcardPositionType | ARCQuery | Enum | Position of wildcard in value, like '*ABC' (-AtStart-), 'ABC*' (-AtEnd-) and |
ARCAPI.RQController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStart | ARCQuery | EnumMember | Example: '*ABC'. |
ARCAPI.DataStorage | ARCAPI | Class | The all-in-memory global application data storage. |
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtEnd | ARCQuery | EnumMember | Example: 'ABC*'. |
ARCAPI.DataStorage.Create | ARCAPI | ClassMember | Creates a -DataStorage- instance with default parameters. |
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStartAndEnd | ARCQuery | EnumMember | Example: '*ABC*'. |
ARCAPI.DataStorage..ctor | ARCAPI | ClassMember | This method will: |
ARCQuery.QueryExpressionWhere+ValueEnum | ARCQuery | Enum | Helper enum used internally by -QueryExpressionWhere- in order to represent queries like WHERE Name = NULL, WHERE Name = NOTNULL and WHERE Name = * (ALL). |
ARCAPI.DataStorage.Storage | ARCAPI | ClassMember | The actual storage. |
ARCQuery.QueryExpressionWhere+ValueEnum.NULL | ARCQuery | EnumMember | |
ARCAPI.DataStorage.ControllerStorage | ARCAPI | ClassMember | Usually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]). |
ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULL | ARCQuery | EnumMember | Practical value enabling suggestions from -GetPrevious- and -GetNext-. |
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload2 | AgoBrowse | ClassMember | Catches all HTTP GET requests to this API. |
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload1 | AgoBrowse | ClassMember | Catches all HTTP POST requests to this API. |
Namespace ARCCore | Namespace | A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to. | |
Namespace ARCDoc | Namespace | A library supporting documentation and demonstrating usage of AgoRapide. | |
Namespace ARCQuery | Namespace | ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs. | |
Namespace ARCAPI | Namespace | A library providing an API on top of the -PropertyStream-. | |
Namespace AgoBrowse | Namespace | ||
Namespace AgoBrowse.Controllers | Namespace | ||
AgoBrowse.Root.TryGetP | AgoBrowse | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
AgoBrowse.Root.TryGetV | AgoBrowse | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
AgoBrowse.Root.ToString | AgoBrowse | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
AgoBrowse.Controllers.CompileController | AgoBrowse | Class | Compiles a hierarchical 'picture book' from the requested position in the -DataStorage-. |
AgoBrowse.Controllers.CompileController.APIMethod | AgoBrowse | ClassMember | The (only) API method that this controller supports. |
AgoBrowse.Controllers.CompileController.Compile | AgoBrowse | ClassMember | Compiles a hierarchical 'picture book' from the given parameter. |
AgoBrowse.Controllers.CompileController.ToString | AgoBrowse | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
AgoBrowse.Controllers.ControllerFacade | AgoBrowse | Class | Facade for entry into the desired -RQController-. |
ARCQuery.QueryExpressionAggregate.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCQuery.QueryExpressionAggregate.SyntaxHelp | ARCQuery | ClassMember | 1) 'AGGREGATE {rowKey}' like "AGGREGATE Product" |
ARCQuery.QueryExpressionAggregate.AggregationType | ARCQuery | ClassMember | Most common value is -Count-, in which case -AggregationKey- may be correspondingly set to null. |
ARCQuery.QueryExpressionAggregate.AggregationKey | ARCQuery | ClassMember | This is often null (with -AggregationType- correspondingly set to Count-). |
ARCQuery.QueryExpressionAll | ARCQuery | Class | Represents all entities for a given collection. |
ARCQuery.QueryExpressionAll.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
ARCQuery.QueryExpressionAll.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCQuery.QueryExpressionAll.SyntaxHelp | ARCQuery | ClassMember | 'ALL' (literally). |
ARCQuery.QueryExpressionCache | ARCQuery | Class | Describes if cache is to be used or not. |
ARCQuery.QueryExpressionCache.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
ARCQuery.QueryExpressionCache.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCQuery.QueryExpressionCache.SyntaxHelp | ARCQuery | ClassMember | CACHE {ON|OFF} |
ARCQuery.QueryExpressionComment | ARCQuery | Class | Allows insertion of SQL style comments (beginning with double hyphens / minus signs, '--') into queries. |
ARCQuery.QueryExpressionComment.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
ARCQuery.QueryExpressionComment.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCQuery.QueryExpressionComment.SyntaxHelp | ARCQuery | ClassMember | COMMENT {comment text} |
ARCQuery.QueryExpressionDataStorage | ARCQuery | Class | Experimental as of Mar 2022: Resets value for -DataStorage- |
ARCQuery.QueryExpressionDataStorage.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
ARCQuery.QueryExpressionDataStorage.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCQuery.QueryExpressionDataStorage.SyntaxHelp | ARCQuery | ClassMember | DATASTORAGE {new hierarchical level} [link adjustment] |
ARCQuery.QueryExpressionDataStorage.LinkAdjustment | ARCQuery | ClassMember | See -LinkAdjustment- for documentation. |
ARCQuery.QueryExpressionDataStorage.GlobalDataStorage | ARCQuery | ClassMember | TODO: Find some better initialization here. |
ARCQuery.QueryExpressionHint | ARCQuery | Class | Describes if hints are to be generated (as query progresses) for potential new queries. |
ARCQuery.QueryExpressionHint.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
ARCQuery.QueryExpressionHint.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCQuery.QueryExpressionHint.SyntaxHelp | ARCQuery | ClassMember | HINT {ON|OFF} |
ARCQuery.QueryExpressionLimit | ARCQuery | Class | Limits the final HTML presentation of results (limits the number of elements being presented). |
ARCQuery.QueryExpressionLimit.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
ARCQuery.QueryExpressionLimit.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCQuery.QueryExpressionLimit.SyntaxHelp | ARCQuery | ClassMember | Syntax: LIMIT {limit} like 'LIMIT 42' |
ARCQuery.QueryExpressionLog | ARCQuery | Class | A debugging tool used to extract detailed log information about the execution of the query. |
ARCQuery.QueryExpressionLog.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
ARCQuery.QueryExpressionLog.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCQuery.QueryExpressionLog.SyntaxHelp | ARCQuery | ClassMember | 'Log'. |
ARCQuery.QueryExpressionOrderBy | ARCQuery | Class | Orders collection. |
ARCQuery.QueryExpressionOrderBy.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
ARCQuery.QueryExpressionOrderBy.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCQuery.QueryExpressionOrderBy.SyntaxHelp | ARCQuery | ClassMember | ORDER BY {key} [DESC] / [ASC] |
ARCQuery.QueryExpressionPivot | ARCQuery | Class | Creates a table by querying over two keys like |
ARCQuery.QueryExpressionPivot.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
ARCQuery.QueryExpressionPivot.GetCrossSummationChecker | ARCQuery | ClassMember | Returns a cross sum checker for int, long, double, Timespan. |
ARCQuery.QueryExpressionPivot.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCQuery.QueryExpressionPivot.SyntaxHelp | ARCQuery | ClassMember | 1) 'PIVOT {rowKey} BY {columnKey}' like "PIVOT Colour BY Production.Year" |
ARCQuery.QueryExpressionPivot.AggregationType | ARCQuery | ClassMember | Most common value is -Count-, in which case -AggregationKey- may be correspondingly set to null. |
ARCQuery.QueryExpressionPivot.AggregationKey | ARCQuery | ClassMember | This is often null (with -AggregationType- correspondingly set to Count-). |
ARCQuery.QueryExpressionRel | ARCQuery | Class | Enables 'jumping' or 'travelling' from a collection of one entity type to another (related) entity type. |
ARCQuery.QueryExpressionRel.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
ARCQuery.QueryExpressionRel.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCQuery.QueryExpressionRel.SyntaxHelp | ARCQuery | ClassMember | 'REL {type}' |
ARCQuery.QueryExpressionRel.StrType | ARCQuery | ClassMember | In the simplest terms, the -ToStringVeryShort- representation of the type that we are 'jumping' to. |
ARCQuery.QueryExpressionSelect | ARCQuery | Class | Selects which fields to include. |
ARCQuery.QueryExpressionSelect.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
ARCQuery.QueryExpressionSelect.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCQuery.QueryExpressionSelect.SyntaxHelp | ARCQuery | ClassMember | SELECT {field-1}, {field-2} ... {field-n} |
ARCQuery.QueryExpressionSelfCreate | ARCQuery | Class | Returns self created collection from given class type. |
ARCQuery.QueryExpressionSelfCreate.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
Generated 2025-06-22 09:43:59.401 UTC