[ROOT]  doc  DocFrag  SELECT Assembly, DocFragType, Description.FirstLine()   <  SKIP 1043  >   <  TAKE 896  >   

134 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCAPI.BaseControllerARCAPIClassContains basic functionality for serving API methods.
ARCAPI.BaseController.BuildControllerStorageARCAPIClassMemberBuilds a collection of 'std' (standard) controller instances to use for serving API requests.
ARCAPI.BaseController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCAPI.BaseController.CatchAllARCAPIClassMemberServes the typical single generic API method in an AgoRapide API.
ARCAPI.BaseController.TryNavigateToLevelInDataStorageARCAPIClassMemberNavigates to the specified level (usually within -Storage-).
ARCAPI.BaseController.GetFormatAndAdjustRequestARCAPIClassMemberDecides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).
ARCQuery.TranslationSingle.TryGetMacroARCQueryClassMemberReturns a -PropertyStream- representation of this translation.
ARCQuery.ForeignKey+ForeignKeySingleStepARCQueryClassDescribes how to traverse between related entities.
ARCQuery.TranslationSingle.TryGetPARCQueryClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCQuery.ForeignKey+ForeignKeySingleStep.ForeignEntitiesCollectionARCQueryClassMemberThe collection containing all the (foreign) entities for the type that this step leads to
ARCQuery.TranslationSingle.TryGetVARCQueryClassMemberNote 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).
ARCQuery.QueryExpressionSelfCreate+ISelfCreateCollectionARCQueryClassProvides a standardized mechanism for describing classes that are able to autogenerate collection of themeselves.
ARCQuery.TranslationSingle.ToStringARCQueryClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.ForeignKeyDirectionARCQueryEnumDescribes the type of traversing to a foreign entity possible.
ARCQuery.TranslationSingle.ReferenceCountARCQueryClassMemberMay be set from outside, for instance with System.Threading.Interlocked.Increment.
ARCQuery.ForeignKeyDirection.ToOneARCQueryEnumMemberTraverse to one entity, like traversing from OrderLine to Order (based on OrderLine containing foreign key OrderId) or Order to Customer (based on Order containing foreign key CustomerId).
ARCQuery.UtilQueryARCQueryClassUtility methods for -ARCQuery-.
ARCQuery.ForeignKeyDirection.ToManyARCQueryEnumMemberTraverse to many entities, like traversing from Customer to Order (based on Order containing foreign key CustomerId) or Order to OrderLine (based on OrderLine containing foreign key OrderId).
ARCQuery.UtilQuery.IndexOfOutsideOfARCQueryClassMemberEquivalent to string.IndexOf except that any character encountered inside pairs of the 'outsideOf'-char are not counted.
ARCQuery.AggregationTypeARCQueryEnumUsed by -QueryExpressionPivot- and -QueryExpressionAggregate-.
ARCQuery.UtilQuery.IndexOfAnyOutsideOfARCQueryClassMemberEquivalent to string.IndexOfAny except that any character encountered inside pairs of the 'outsideOf'-char are not counted.
ARCQuery.AggregationType.CountARCQueryEnumMember 
ARCQuery.UtilQuery.SplitOutsideOfARCQueryClassMemberEquivalent to string.Split except that any character encountered inside pairs of the 'outsideOf'-char are not counted as separators.
ARCQuery.AggregationType.SumARCQueryEnumMember 
ARCQuery.UtilQuery.SpecialLinkPrefixesARCQueryClassMemberContains prefixes for which links (see -LinkInsertionInDocumentation-) are also desired without the prefix.
ARCQuery.RelationalOperatorARCQueryEnumRelational / comparision operators.
ARCQuery.ValueComparerARCQueryClassCan evaluation expressions like 'WHERE Created = ThisYear.
ARCQuery.RelationalOperator.EQARCQueryEnumMember 
ARCQuery.ValueComparer.TryGetPreviousARCQueryClassMemberSuggestion for previous query (browsing 'backwards')
ARCQuery.RelationalOperator.CONTAINSARCQueryEnumMember 
ARCQuery.ValueComparer.TryGetNextARCQueryClassMemberSuggestion for next query (browsing 'forwards')
ARCQuery.RelationalOperator.NEQARCQueryEnumMember 
ARCQuery.ValueComparerDateTimeARCQueryClass-ValueComparerDateTime- is an attempt at offering a human language interface for date and time queries.
ARCQuery.RelationalOperator.NOTCONTAINSARCQueryEnumMember 
ARCQuery.ValueComparerDateTime.TryGetPreviousARCQueryClassMemberSuggestion for previous query (browsing 'backwards')
ARCQuery.RelationalOperator.GTARCQueryEnumMember 
ARCQuery.ValueComparerDateTime.TryGetNextARCQueryClassMemberSuggestion for next query (browsing 'forwards')
ARCQuery.RelationalOperator.LTARCQueryEnumMember 
ARCQuery.ValueComparerDateTime.TryParseARCQueryClassMemberNote: This parser is probably exhaustive but not necessarily logical
ARCQuery.RelationalOperator.GEQARCQueryEnumMember 
ARCQuery.ValueComparerDateTime.ResolutionARCQueryClassMemberSee -ResolutionEnum-.
ARCQuery.RelationalOperator.LEQARCQueryEnumMember 
ARCQuery.ValueComparerDateTime.StepsARCQueryClassMemberValue 0 would mean 'This', like ThisHour, Today, ThisMonth and so on.
ARCQuery.RelationalOperator.LIKEARCQueryEnumMemberCase sensitive string wildcard comparision.
ARCQuery.ValueComparerDateTime.IsGlidingARCQueryClassMemberThe modifier 'Gliding' (or just 'G') can be appended in order to mean continous gliding periode, so for instance
ARCQuery.RelationalOperator.ILIKEARCQueryEnumMemberCase insensitive string wildcard comparision.
ARCQuery.ValueComparerDateTime.IsBeforeARCQueryClassMemberThe modifier 'Before' can be prepended in order to mean from any time before the specified time.
ARCQuery.RelationalOperator.NOTLIKEARCQueryEnumMemberCase sensitive string wildcard comparision.
ARCQuery.ValueComparerDateTime.IsAfterARCQueryClassMemberThe modifier 'After' can be prepended in order to mean any time after the specified time.
ARCQuery.RelationalOperator.NOTILIKEARCQueryEnumMemberCase insensitive string wildcard comparision.
ARCQuery.ValueComparerDateTime.IsIntervalARCQueryClassMemberNormally the interval which is compared against is the timespan corresponding to -Resolution-.
ARCQuery.StrictnessARCQueryEnumDescribes level of -Strictness- when executing query.
ARCQuery.ValueComparerDateTime.InitValueARCQueryClassMemberFor debugging purposes. The initial 'now' value used before calculating -StartPeriod- and -EndPeriod-.
ARCQuery.Strictness.ONARCQueryEnumMember 
ARCAPI.BaseController.GetTimestampIsOldWarningHTMLARCAPIClassMemberIf -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format.
ARCQuery.Strictness.OFFARCQueryEnumMember 
ARCAPI.BaseController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.QuantileARCQueryEnumDescribes quantiles like -TERTILE- and -QUARTILE-.
ARCAPI.EditControllerARCAPIClassOffers a simple HTML editing environment of the raw -PropertyStream- from the given key.
ARCQuery.Quantile.MEDIANARCQueryEnumMemberDivide into two parts
ARCAPI.EditController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCQuery.Quantile.TERTILEARCQueryEnumMemberDivide into three parts
ARCAPI.EditController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.Quantile.QUARTILEARCQueryEnumMemberDivide into four parts
ARCAPI.GQControllerARCAPIClassOffers GraphQL queries.
ARCQuery.Quantile.QUINTILEARCQueryEnumMemberDivide into five parts
ARCAPI.GQController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCQuery.Quantile.SEXTILEARCQueryEnumMemberDivide into 6 parts
ARCAPI.GQController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.Quantile.SEPTILEARCQueryEnumMemberDivide into 7 parts
ARCAPI.RQControllerARCAPIClassRQ = REST Query. Executes a REST like query request against the given -DataStorage-.
ARCQuery.Quantile.OCTILEARCQueryEnumMemberDivide into 8 parts
ARCAPI.RQController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCQuery.Quantile.DECILEARCQueryEnumMemberDivide into 10 parts
ARCAPI.RQController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.Quantile.DUODECILEARCQueryEnumMemberDivide into 12 parts
ARCAPI.DataStorageARCAPIClassThe all-in-memory global application data storage.
ARCQuery.Quantile.HEXADECILEARCQueryEnumMemberDivide into 16 parts
ARCAPI.DataStorage.CreateARCAPIClassMemberCreates a -DataStorage- instance with default parameters.
ARCQuery.Quantile.VENTILEARCQueryEnumMemberDivide into 20 parts
ARCAPI.DataStorage..ctorARCAPIClassMemberThis method will:
ARCQuery.Quantile.PERCENTILEARCQueryEnumMemberDivide into 100 parts
ARCAPI.DataStorage.StorageARCAPIClassMemberThe actual storage.
ARCQuery.Quantile.PERMILLEARCQueryEnumMemberDivide into 1000 parts
ARCAPI.DataStorage.ControllerStorageARCAPIClassMemberUsually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]).
ARCQuery.QueryProgressPARCQueryEnumDescribes class -QueryProgress-.
ARCAPI.DataStorage.DocLinksARCAPIClassMemberNote that may be null.
ARCQuery.QueryProgressP.TitleARCQueryEnumMemberThe title to be used in the final presentation of the query result.
ARCAPI.DataStorage.LockARCAPIClassMemberLocking object for thread-safe access from simultaneous API requests.
ARCQuery.QueryProgressP.QueriesARCQueryEnumMember 
ARCAPI.DataStorage.ExternalReceiverARCAPIClassMemberTypically used by -AddController-.
ARCQuery.QueryProgressP.StrCurrentTypeARCQueryEnumMemberNormally the -ToStringVeryShort- representation of the type of objects in the -Result- collection.
ARCAPI.DataStorage.DoNotStoreInternallyARCAPIClassMemberTypically used by -AddController-.
ARCQuery.QueryProgressP.CurrentStrictnessARCQueryEnumMemberDescribes -Strictness- ON / OFF when executing query.
ARCAPI.BaseControllerPARCAPIEnumDescribes class -BaseController-.
ARCQuery.QueryProgressP.CreateHintsARCQueryEnumMemberDescribes if hints are to be generated (as query progresses) for new queries.
ARCAPI.BaseControllerP.CountRequestARCAPIEnumMemberNumber of calls to -APIMethod- since application initialization
ARCQuery.QueryProgressP.UseCacheARCQueryEnumMemberDescribes if cache is to be used or not.
ARCAPI.BaseControllerP.CountExceptionARCAPIEnumMemberNumber of exceptions at call to -APIMethod- since application initialization
ARCQuery.QueryProgressP.LinkAdjustmentARCQueryEnumMemberExperimental: Adjustment to be done by -QueryProgress-.- ToHTMLSimpleSingle- (when it ascertains how to go back to root level).
ARCAPI.BaseControllerP.LogLevelARCAPIEnumMember 
ARCQuery.QueryProgressP.LimitARCQueryEnumMemberLimits 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.ResponseFormatARCAPIEnumThe response format, HTML or JSON, for an API request.
ARCQuery.QueryProgressP.TerminateReasonARCQueryEnumMemberThe reason for a query being terminated. This property should contain a user friendly message about the problem and how to fix it.
ARCAPI.ResponseFormat.JSONARCAPIEnumMember 
ARCQuery.QueryProgressP.AllLogEntriesForThisQueryARCQueryEnumMember 
ARCAPI.ResponseFormat.HTMLARCAPIEnumMember 
ARCQuery.TranslationsPARCQueryEnumThis enum has no values because the keys are the actual string to be translated.
Assembly AgoBrowse Assembly 
ARCQuery.TranslationSinglePARCQueryEnumDescribes class -TranslationSingle-.
AgoBrowse.ProgramAgoBrowseClass 
ARCQuery.TranslationSingleP.TextARCQueryEnumMember 
AgoBrowse.Program.InitStreamProcessorAgoBrowseClassMemberInitializes stream processor.
ARCQuery.TranslationSingleP.IsMissingARCQueryEnumMemberValue TRUE indicates that the Text given is simply the original key, in other words, the translation for the key is actually missing.
AgoBrowse.RootAgoBrowseClassContains the user friendly welcome text (front page) for the application.
ARCQuery.EntityMethodKey+MethodTypeARCQueryEnumExplains type of method signature found (trough reflection) for corresponding entity class.
AgoBrowse.Root.ToHTMLSimpleSingleAgoBrowseClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCQuery.EntityMethodKey+MethodType.SimpleARCQueryEnumMemberSignature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)'
AgoBrowse.Root.TryGetPAgoBrowseClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
AgoBrowse.Root.TryGetVAgoBrowseClassMemberNote 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.ToStringAgoBrowseClassMemberTODO: Decide on what we actually want with ToString for this class.
AgoBrowse.Controllers.CompileControllerAgoBrowseClassCompiles a hierarchical 'picture book' from the requested position in the -DataStorage-.
AgoBrowse.Controllers.CompileController.APIMethodAgoBrowseClassMemberThe (only) API method that this controller supports.
AgoBrowse.Controllers.CompileController.CompileAgoBrowseClassMemberCompiles a hierarchical 'picture book' from the given parameter.
AgoBrowse.Controllers.CompileController.ToStringAgoBrowseClassMemberTODO: Decide on what we actually want with ToString for this class.
AgoBrowse.Controllers.ControllerFacadeAgoBrowseClassFacade for entry into the desired -RQController-.
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload2AgoBrowseClassMemberCatches all HTTP GET requests to this API.
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload1AgoBrowseClassMemberCatches all HTTP POST requests to this API.
Namespace ARCCore NamespaceA necessary library (.DLL in Windows terms) that every -ARNodeType- should link to.
Namespace ARCDoc NamespaceA library supporting documentation and demonstrating usage of AgoRapide.
Namespace ARCQuery NamespaceARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
Namespace ARCAPI NamespaceA library providing an API on top of the -PropertyStream-.
Namespace AgoBrowse Namespace 
Namespace AgoBrowse.Controllers Namespace 

Generated 2025-07-11 07:42:54.739 UTC