[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 938 > < TAKE 248 >
129 items
| DocFragId | Assembly | DocFragType | Description.FirstLine() |
|---|---|---|---|
| ARCAPI.BaseController | ARCAPI | Class | Contains basic functionality for serving API methods. |
| ARCQuery.Extensions | ARCQuery | Class | |
| ARCQuery.CompoundKey | ARCQuery | Class | A class able to expand the concept of entity keys. |
| 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. |
| ARCQuery.Extensions.TryGetP | ARCQuery | ClassMember | Same functionality as -TryGetP- but understands the concept of -CompoundKey-. |
| ARCQuery.CompoundKey.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| 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. |
| ARCQuery.FunctionKeyAggregate | ARCQuery | Class | Operates over a collection of properties. |
| ARCQuery.CompoundKey.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
| 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. |
| ARCQuery.FunctionKeyAggregate.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCQuery.CompoundKey.Parse | ARCQuery | ClassMember | Note that no TryParse is offered here, because Parse will always succeed (it just returns -CompoundInvalidKey- if 'fails'). |
| 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-). |
| ARCQuery.FunctionKeyAggregateAvg | ARCQuery | Class | Calculates the average of the given properties. |
| ARCQuery.CompoundKey.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.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.GetFormatAndAdjustRequest | ARCAPI | ClassMember | Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on). |
| ARCQuery.FunctionKeyAggregateAvg.SyntaxHelp | ARCQuery | ClassMember | 'Avg()' |
| ARCQuery.CompoundKey.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
| 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.GetTimestampIsOldWarningHTML | ARCAPI | ClassMember | If -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format. |
| ARCQuery.FunctionKeyAggregateCount | ARCQuery | Class | Counts the number of properties found. |
| ARCQuery.MemberEntityKey.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| ARCQuery.QueryProgressP.AllLogEntriesForThisQuery | ARCQuery | EnumMember | |
| ARCAPI.BaseController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCQuery.FunctionKeyAggregateCount.SyntaxHelp | ARCQuery | ClassMember | 'Count()' |
| ARCQuery.MemberEntityKey.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
| ARCQuery.EntityMethodKey+MethodType | ARCQuery | Enum | Explains type of method signature found (trough reflection) for corresponding entity class. |
| ARCAPI.EditController | ARCAPI | Class | Offers a simple HTML editing environment of the raw -PropertyStream- from the given key. |
| ARCQuery.FunctionKeyAggregateDistinct | ARCQuery | Class | Returns a list of the distinct values of the given properties. |
| ARCQuery.MemberEntityKey.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
| ARCQuery.EntityMethodKey+MethodType.Simple | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)' |
| ARCAPI.EditController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCQuery.FunctionKeyAggregateDistinct.SyntaxHelp | ARCQuery | ClassMember | 'Distinct()' |
| ARCQuery.OrdinaryKeyPlusFunctionOrQuantile | ARCQuery | Class | A -CompoundKey- containing some function keys or quantile key operating on an existing property of the entity in question. |
| ARCQuery.EntityMethodKey+MethodType.Complex | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)' |
| ARCAPI.EditController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCQuery.FunctionKeyAggregateJoin | ARCQuery | Class | Joins the given list of properties into a single property. |
| ARCQuery.OrdinaryKeyPlusFunctionOrQuantile.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
| 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.GQController | ARCAPI | Class | Offers GraphQL queries. |
| ARCQuery.FunctionKeyAggregateJoin.SyntaxHelp | ARCQuery | ClassMember | 'Join()' |
| ARCQuery.OrdinaryKeyPlusFunctionOrQuantile.ToString | ARCQuery | ClassMember | The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'. |
| ARCQuery.QueryExpressionWhere+ValueEnum.NULL | ARCQuery | EnumMember | |
| ARCAPI.GQController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCQuery.FunctionKeyAggregateMax | |||
| ARCQuery.OrdinaryKeyPlusFunctionOrQuantile.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULL | ARCQuery | EnumMember | Practical value enabling suggestions from -GetPrevious- and -GetNext-. |
| ARCAPI.GQController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCQuery.FunctionKeyAggregateMax.SyntaxHelp | ARCQuery | ClassMember | 'Max()' |
| ARCQuery.OrdinaryKeyPlusFunctionOrQuantile..ctor | ARCQuery | ClassMember | Note that calling only this constructor without afterwards setting -FunctionKeys- and / or -QuantileKey- would be meaningless. |
| ARCAPI.RQController | ARCAPI | Class | RQ = REST Query. Executes a REST like query request against the given -DataStorage-. |
| AgoMail.Controllers.ControllerFacade.CatchAll Overload2 | AgoMail | ClassMember | Catches all HTTP GET requests to this API. |
| ARCQuery.FunctionKeyYearMonth | ARCQuery | Class | Extracts Year + Month component from field like 2020-06. |
| ARCQuery.FunctionKeyDayOfWeek.SyntaxHelp | ARCQuery | ClassMember | 'DayOfWeek()' |
| ARCAPI.RQController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| AgoMail.Controllers.ControllerFacade.CatchAll Overload1 | AgoMail | ClassMember | Catches all HTTP POST requests to this API. |
| ARCQuery.FunctionKeyYearMonth.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCQuery.FunctionKeyDouble | ARCQuery | Class | Converts an integer to a double (decimal value). |
| ARCAPI.RQController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| AgoMail.EmailP | AgoMail | Enum | |
| ARCQuery.FunctionKeyYearMonth.SyntaxHelp | ARCQuery | ClassMember | 'YearMonth()' |
| ARCQuery.FunctionKeyDouble.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCAPI.DataStorage | ARCAPI | Class | The all-in-memory global application data storage. |
| AgoMail.EmailP.Date | AgoMail | EnumMember | UTC-format |
| ARCQuery.FunctionKeyYearQuarter | ARCQuery | Class | Extracts Year + Quarter component from field like 2020Q1. |
| ARCQuery.FunctionKeyDouble.SyntaxHelp | ARCQuery | ClassMember | 'Double()' |
| ARCAPI.DataStorage.Create | ARCAPI | ClassMember | Creates a -DataStorage- instance with default parameters. |
| AgoMail.EmailP.From | AgoMail | EnumMember | |
| ARCQuery.FunctionKeyYearQuarter.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCQuery.FunctionKeyFirstLine | ARCQuery | Class | Extracts first line from string of text. |
| ARCAPI.DataStorage..ctor | ARCAPI | ClassMember | This method will: |
| AgoMail.EmailP.To | AgoMail | EnumMember | |
| ARCQuery.FunctionKeyYearQuarter.SyntaxHelp | ARCQuery | ClassMember | 'YearQuarter()' |
| ARCQuery.FunctionKeyFirstLine.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCAPI.DataStorage.Storage | ARCAPI | ClassMember | The actual storage. |
| AgoMail.EmailP.CC | AgoMail | EnumMember | |
| ARCQuery.FunctionKeyYearWeek | ARCQuery | Class | Extract year and week number from field according to ISO 8601 like '2021-51' |
| ARCQuery.FunctionKeyFirstLine.SyntaxHelp | ARCQuery | ClassMember | 'FirstLine()' |
| ARCAPI.DataStorage.ControllerStorage | ARCAPI | ClassMember | Usually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]). |
| AgoMail.EmailP.Subject | AgoMail | EnumMember | |
| ARCQuery.FunctionKeyYearWeek.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCQuery.FunctionKeyHourMinute | ARCQuery | Class | Formats a timespan with only the hour and minute part. Uses format hh:mm. |
| ARCAPI.DataStorage.DocLinks | ARCAPI | ClassMember | Note that may be null. |
| AgoMail.EmailP.TextBody | AgoMail | EnumMember | |
| ARCQuery.FunctionKeyYearWeek.SyntaxHelp | ARCQuery | ClassMember | 'YearWeek()' |
| ARCAPI.DataStorage.Lock | ARCAPI | ClassMember | Locking object for thread-safe access from simultaneous API requests. |
| AgoMail.EmailP.HTMLBody | AgoMail | EnumMember | |
| ARCQuery.NewKey | ARCQuery | Class | A function creating new keys (new fields) that can be used against all object types in AgoRapide (against all entities). |
| ARCAPI.DataStorage.ExternalReceiver | ARCAPI | ClassMember | Typically used by -AddController-. |
| AgoMail.EmailP.Headers | AgoMail | EnumMember | |
| ARCQuery.NewKey.AddParser | ARCQuery | ClassMember | Adds a -ApplicationSpecificCode- parser. |
| ARCAPI.DataStorage.DoNotStoreInternally | ARCAPI | ClassMember | Typically used by -AddController-. |
| AgoMail.EmailP.Attachments | AgoMail | EnumMember | |
| ARCQuery.NewKey.TryParse | ARCQuery | ClassMember | Find parsers from -Parsers- based on first word in query. |
| ARCAPI.BaseControllerP | ARCAPI | Enum | Describes class -BaseController-. |
| Namespace ARCCore | Namespace | A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to. | |
| ARCQuery.NewKey.TryParseSingleWord | ARCQuery | ClassMember | Recommended parser to use for functions without parameters. |
| ARCAPI.BaseControllerP.CountRequest | ARCAPI | EnumMember | Number of calls to -APIMethod- since application initialization |
| Namespace ARCDoc | Namespace | A library supporting documentation and demonstrating usage of AgoRapide. | |
| ARCQuery.NewKey.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| ARCAPI.BaseControllerP.CountException | ARCAPI | EnumMember | Number of exceptions at call to -APIMethod- since application initialization |
| Namespace ARCQuery | Namespace | ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs. | |
| ARCQuery.NewKey.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
| ARCAPI.BaseControllerP.LogLevel | ARCAPI | EnumMember | |
| Namespace ARCAPI | Namespace | A library providing an API on top of the -PropertyStream-. | |
| ARCQuery.NewKey.ToString | ARCQuery | ClassMember | The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'. |
| ARCAPI.ResponseFormat | ARCAPI | Enum | The response format, HTML or JSON, for an API request. |
| Namespace AgoMail | Namespace | ||
| ARCAPI.ResponseFormat.JSON | ARCAPI | EnumMember | |
| Namespace AgoMail.Controllers | Namespace | ||
| ARCAPI.ResponseFormat.HTML | ARCAPI | EnumMember | |
| Assembly AgoMail | Assembly | ||
| AgoMail.Cleaner | AgoMail | Class | |
| AgoMail.Cleaner.Clean | AgoMail | ClassMember | Removes emails with often seen values for Subject, To or From. |
| AgoMail.Email | AgoMail | Class | |
| AgoMail.Email.TryGetV | AgoMail | 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). |
| AgoMail.Email.ToString | AgoMail | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| AgoMail.Program | AgoMail | Class | Application startup and initialization |
| AgoMail.Program.InitStreamProcessor | AgoMail | ClassMember | Initializes stream processor. |
| AgoMail.Root | AgoMail | Class | Contains the user friendly welcome text (front page) for the application. |
| AgoMail.Root.ToHTMLSimpleSingle | AgoMail | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| AgoMail.Root.TryGetV | AgoMail | 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). |
| AgoMail.Root.ToString | AgoMail | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| AgoMail.Controllers.ControllerFacade | AgoMail | Class | Facade for entry into the desired -BaseController-. |
Generated 2026-11-04 02:40:43.646 UTC