[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 1058 > < TAKE 224 >
119 items
DocFragId | Assembly | DocFragType | Description.FirstLine() |
---|---|---|---|
ARCAPI.ContentResult | ARCAPI | Class | Mimicks Microsoft.AspNetCore.Mvc.ContentResult. |
ARCQuery.NewKeyCountPRec.SyntaxHelp | ARCQuery | ClassMember | 'CountPRec()' |
ARCQuery.QueryProgressP.CurrentStrictness | ARCQuery | EnumMember | Describes -Strictness- ON / OFF when executing query. |
ARCAPI.ContentResult.CreateHTMLOK | ARCAPI | ClassMember | NOTE: Parameter must be a complete HTML page. |
ARCQuery.NewKeyCountPRec.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
ARCQuery.QueryProgressP.CreateHints | ARCQuery | EnumMember | Describes if hints are to be generated (as query progresses) for new queries. |
ARCAPI.ContentResult.CreateError | ARCAPI | ClassMember | TODO: Add a key / value format for error messages, like done for -Log-. |
ARCQuery.NewKeyCountPRec.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
ARCQuery.QueryProgressP.UseCache | ARCQuery | EnumMember | Describes if cache is to be used or not. |
ARCAPI.AddController | ARCAPI | Class | Parses and stores a -PropertyStreamLine-. |
ARCQuery.NewKeyGetType | ARCQuery | Class | Returns the internal C# object type of the given object. |
ARCQuery.QueryProgressP.LinkAdjustment | ARCQuery | EnumMember | Experimental: Adjustment to be done by -QueryProgress-.- ToHTMLSimpleSingle- (when it ascertains how to go back to root level). |
ARCAPI.AddController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
ARCQuery.NewKeyGetType.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
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.AddController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCQuery.NewKeyGetType.ToString | ARCQuery | ClassMember | The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'. |
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.AddController.AllowFilter | ARCAPI | ClassMember | Describes what data is allowed to change through a list of -Subscription- instances. |
ARCQuery.NewKeyGetType.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
ARCQuery.QueryProgressP.AllLogEntriesForThisQuery | ARCQuery | EnumMember | |
ARCAPI.BaseController | ARCAPI | Class | Contains basic functionality for serving API methods. |
ARCQuery.NewKeyGetType.SyntaxHelp | ARCQuery | ClassMember | 'GetType()' |
ARCQuery.TranslationsP | ARCQuery | Enum | This enum has no values because the keys are the actual string to be translated. |
ARCAPI.BaseController.BuildControllerStorage | ARCAPI | ClassMember | Builds a collection of 'std' (standard) controller instances to use for serving API requests. |
ARCQuery.NewKeyGetType.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
ARCQuery.TranslationSingleP | ARCQuery | Enum | Describes class -TranslationSingle-. |
ARCAPI.BaseController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
ARCQuery.NewKeyGetType.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
ARCQuery.TranslationSingleP.Text | ARCQuery | EnumMember | |
ARCAPI.BaseController.CatchAll | ARCAPI | ClassMember | Serves the typical single generic API method in an AgoRapide API. |
ARCQuery.NewKeyToPropertyStream | ARCQuery | Class | Returns the -PropertyStream- representation of the given object. |
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.BaseController.TryNavigateToLevelInDataStorage | ARCAPI | ClassMember | Navigates to the specified level (usually within -Storage-). |
ARCQuery.NewKeyToPropertyStream.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
ARCQuery.EntityMethodKey+MethodType | ARCQuery | Enum | Explains type of method signature found (trough reflection) for corresponding entity class. |
ARCAPI.BaseController.GetFormatAndAdjustRequest | ARCAPI | ClassMember | Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on). |
ARCQuery.NewKeyToPropertyStream.ToString | ARCQuery | ClassMember | The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'. |
ARCQuery.EntityMethodKey+MethodType.Simple | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)' |
ARCQuery.QueryExpressionTake.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCAPI.BaseController.GetTimestampIsOldWarningHTML | ARCAPI | ClassMember | If -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format. |
ARCQuery.QueryExpressionTake.SyntaxHelp | ARCQuery | ClassMember | TAKE {Count} |
ARCAPI.BaseController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCQuery.QueryExpressionThenBy | ARCQuery | Class | Allows sorting by multiple columns. |
ARCAPI.EditController | ARCAPI | Class | Offers a simple HTML editing environment of the raw -PropertyStream- from the given key. |
ARCQuery.QueryExpressionThenBy.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
ARCAPI.EditController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
ARCQuery.QueryExpressionThenBy.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCAPI.EditController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCQuery.QueryExpressionThenBy.SyntaxHelp | ARCQuery | ClassMember | THEN BY {key} [DESC] / [ASC] |
ARCAPI.GQController | ARCAPI | Class | Offers GraphQL queries. |
ARCQuery.QueryExpressionTitle | ARCQuery | Class | The title to be used in the final presentation of the query result. |
ARCAPI.GQController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
ARCQuery.QueryExpressionTitle.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
ARCAPI.GQController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCQuery.QueryExpressionTitle.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCAPI.RQController | ARCAPI | Class | RQ = REST Query. Executes a REST like query request against the given -DataStorage-. |
ARCQuery.QueryExpressionTitle.SyntaxHelp | ARCQuery | ClassMember | TITLE {title} |
ARCAPI.RQController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
ARCQuery.QueryExpressionWhere | ARCQuery | Class | Executes a 'WHERE {key} {operator} {value}' against the given collection. |
ARCAPI.RQController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCQuery.QueryExpressionWhere.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
ARCAPI.DataStorage | ARCAPI | Class | The all-in-memory global application data storage. |
ARCQuery.QueryExpressionWhere.IsMatch | ARCQuery | ClassMember | Returns TRUE if property matches criteria. |
ARCAPI.DataStorage.Create | ARCAPI | ClassMember | Creates a -DataStorage- instance with default parameters. |
ARCQuery.QueryExpressionWhere.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCAPI.DataStorage..ctor | ARCAPI | ClassMember | This method will: |
ARCQuery.QueryExpressionWhere.SyntaxHelp | ARCQuery | ClassMember | WHERE {key} {operator} {value} |
ARCAPI.DataStorage.Storage | ARCAPI | ClassMember | The actual storage. |
ARCQuery.QueryExpressionWhere.Value | ARCQuery | ClassMember | The Value should ideally be as strongly typed as possible. Note that it may be of type -ValueEnum- relevant for queries like WHERE Name = NULL. |
ARCAPI.DataStorage.ControllerStorage | ARCAPI | ClassMember | Usually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]). |
ARCQuery.QueryProgress | ARCQuery | Class | Keeps track of execution of query (that is, a query consisting of multiple -QueryExpression-), and also stores final result. |
ARCAPI.DataStorage.DocLinks | ARCAPI | ClassMember | Note that may be null. |
ARCQuery.QueryProgress.ToJSONSerializeable | ARCQuery | ClassMember | Override of default interface method -ToJSONSerializeable- is necessary because resulting data is 'hidden' within -Result-. |
ARCAPI.DataStorage.Lock | ARCAPI | ClassMember | Locking object for thread-safe access from simultaneous API requests. |
ARCQuery.QueryProgress.PreviousQueryJustExecuted | ARCQuery | ClassMember | TODO: This is somewhat loosely associated. |
ARCAPI.DataStorage.ExternalReceiver | ARCAPI | ClassMember | Typically used by -AddController-. |
ARCQuery.QueryProgress.NextQueryToExecute | ARCQuery | ClassMember | TODO: This is somewhat loosely associated. |
ARCAPI.DataStorage.DoNotStoreInternally | ARCAPI | ClassMember | Typically used by -AddController-. |
ARCQuery.QueryProgress.ToHTMLSimpleSingle | ARCQuery | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
ARCAPI.BaseControllerP | ARCAPI | Enum | Describes class -BaseController-. |
ARCQuery.QueryProgress.OrderAndReconstructKeys | ARCQuery | ClassMember | Part 1: |
ARCAPI.BaseControllerP.CountRequest | ARCAPI | EnumMember | Number of calls to -APIMethod- since application initialization |
ARCQuery.QueryProgress.GetHTMLLinksToIndividualQueryParts | ARCQuery | ClassMember | Is able to generate the following: |
ARCAPI.BaseControllerP.CountException | ARCAPI | EnumMember | Number of exceptions at call to -APIMethod- since application initialization |
ARCQuery.QueryProgress.ToString | ARCQuery | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCAPI.BaseControllerP.LogLevel | ARCAPI | EnumMember | |
ARCQuery.QueryProgress.DataStorage | ARCQuery | ClassMember | Note how this property will point to the hierarhical level in the data storage from which the first -QueryExpression- was found in the query string. |
ARCAPI.ResponseFormat | ARCAPI | Enum | The response format, HTML or JSON, for an API request. |
ARCQuery.QueryProgress.Result | ARCQuery | ClassMember | This gets updated continously as the different query expressions get evaluated. |
ARCAPI.ResponseFormat.JSON | ARCAPI | EnumMember | |
ARCQuery.QueryProgress.ExecutedQueries | ARCQuery | ClassMember | The result from calling -Execute- for each query in -Queries-. |
ARCAPI.ResponseFormat.HTML | ARCAPI | EnumMember | |
ARCQuery.QueryProgress.AdditionalJavascriptUrlEncoder | ARCQuery | ClassMember | Returns the Javascript code for converting characters that are difficult to pass in URLs to a format understood by -Decode-. |
Assembly AgoBrowse | Assembly | ||
ARCQuery.Translations | ARCQuery | Class | Offers a very simple system for keeping track of translation between different ("western") languages. |
AgoBrowse.Program | AgoBrowse | Class | |
ARCQuery.Translations.ToString | ARCQuery | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
AgoBrowse.Program.InitStreamProcessor | AgoBrowse | ClassMember | Initializes stream processor. |
ARCQuery.TranslationsCollection | ARCQuery | Class | This would consist of one key per language, with keys like "de_DE", "fr_FR", "nb_NO". |
AgoBrowse.Root | AgoBrowse | Class | Contains the user friendly welcome text (front page) for the application. |
ARCQuery.TranslationsCollection.TrySetPP | ARCQuery | ClassMember | Replaces default interface method -TrySetPP-. |
AgoBrowse.Root.ToHTMLSimpleSingle | AgoBrowse | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
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-. |
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 |
Generated 2025-09-17 20:36:49.561 UTC