[ROOT]  doc  DocFrag  SELECT Assembly, DocFragType, Description.FirstLine()   SKIP 1041   

136 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCAPI.AddController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCAPI.AddController.AllowFilterARCAPIClassMemberDescribes what data is allowed to change through a list of -Subscription- instances.
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.TranslationsCollection.GetKeysEqualToValueARCQueryClassMemberReturns properties which themselves again have key and value equal to the given key and value.
ARCQuery.QueryExpressionTake.TryCheckForExistenceOfKeyARCQueryClassMemberUsed by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.TranslationsCollection.TryGetPARCQueryClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCQuery.QueryExpressionTake.SyntaxHelpARCQueryClassMemberTAKE {Count}
ARCQuery.TranslationsCollection.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.QueryExpressionThenByARCQueryClassAllows sorting by multiple columns.
ARCQuery.TranslationsCollection.ToStringARCQueryClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryExpressionThenBy.ExecuteARCQueryClassMemberTransforms the given input collection into a resulting collection.
ARCQuery.TranslationSingleARCQueryClassDescribes a single translation.
ARCQuery.QueryExpressionThenBy.TryCheckForExistenceOfKeyARCQueryClassMemberUsed by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.TranslationSingle.TryGetReferenceCountARCQueryClassMemberMethod signature understood by -TryGetP- / -EntityMethodKey-.
ARCQuery.QueryExpressionThenBy.SyntaxHelpARCQueryClassMemberTHEN BY {key} [DESC] / [ASC]
ARCQuery.TranslationSingle.TryGetPSARCQueryClassMemberReturns a -PropertyStreamLine- representation of this translation.
ARCQuery.QueryExpressionTitleARCQueryClassThe title to be used in the final presentation of the query result.
ARCQuery.TranslationSingle.TryGetAARCQueryClassMemberReturns a -PropertyStreamLine- representation of this translation.
ARCQuery.QueryExpressionTitle.ExecuteARCQueryClassMemberTransforms the given input collection into a resulting collection.
ARCQuery.TranslationSingle.TryGetMacroARCQueryClassMemberReturns a -PropertyStream- representation of this translation.
ARCQuery.QueryExpressionTitle.TryCheckForExistenceOfKeyARCQueryClassMemberUsed by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.TranslationSingle.TryGetPARCQueryClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCQuery.QueryExpressionTitle.SyntaxHelpARCQueryClassMemberTITLE {title}
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.QueryExpressionWhereARCQueryClassExecutes a 'WHERE {key} {operator} {value}' against the given collection.
ARCQuery.TranslationSingle.ToStringARCQueryClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryExpressionWhere.ExecuteARCQueryClassMemberTransforms the given input collection into a resulting collection.
ARCQuery.TranslationSingle.ReferenceCountARCQueryClassMemberMay be set from outside, for instance with System.Threading.Interlocked.Increment.
ARCQuery.QueryExpressionWhere.IsMatchARCQueryClassMemberReturns TRUE if property matches criteria.
ARCQuery.UtilQueryARCQueryClassUtility methods for -ARCQuery-.
ARCQuery.QueryExpressionWhere.TryCheckForExistenceOfKeyARCQueryClassMemberUsed by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.UtilQuery.IndexOfOutsideOfARCQueryClassMemberEquivalent to string.IndexOf except that any character encountered inside pairs of the 'outsideOf'-char are not counted.
ARCQuery.QueryExpressionWhere.SyntaxHelpARCQueryClassMemberWHERE {key} {operator} {value}
ARCQuery.UtilQuery.IndexOfAnyOutsideOfARCQueryClassMemberEquivalent to string.IndexOfAny except that any character encountered inside pairs of the 'outsideOf'-char are not counted.
ARCQuery.QueryExpressionWhere.ValueARCQueryClassMemberThe Value should ideally be as strongly typed as possible. Note that it may be of type -ValueEnum- relevant for queries like WHERE Name = NULL.
ARCQuery.UtilQuery.SplitOutsideOfARCQueryClassMemberEquivalent to string.Split except that any character encountered inside pairs of the 'outsideOf'-char are not counted as separators.
ARCQuery.QueryProgressARCQueryClassKeeps track of execution of query (that is, a query consisting of multiple -QueryExpression-), and also stores final result.
ARCQuery.UtilQuery.SpecialLinkPrefixesARCQueryClassMemberContains prefixes for which links (see -LinkInsertionInDocumentation-) are also desired without the prefix.
ARCQuery.QueryProgress.ToJSONSerializeableARCQueryClassMemberOverride of default interface method -ToJSONSerializeable- is necessary because resulting data is 'hidden' within -Result-.
ARCQuery.ValueComparerARCQueryClassCan evaluation expressions like 'WHERE Created = ThisYear.
ARCQuery.QueryProgress.PreviousQueryJustExecutedARCQueryClassMemberTODO: This is somewhat loosely associated.
ARCQuery.ValueComparer.TryGetPreviousARCQueryClassMemberSuggestion for previous query (browsing 'backwards')
ARCQuery.QueryProgress.NextQueryToExecuteARCQueryClassMemberTODO: This is somewhat loosely associated.
ARCQuery.ValueComparer.TryGetNextARCQueryClassMemberSuggestion for next query (browsing 'forwards')
ARCQuery.QueryProgress.ToHTMLSimpleSingleARCQueryClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCQuery.ValueComparerDateTimeARCQueryClass-ValueComparerDateTime- is an attempt at offering a human language interface for date and time queries.
ARCQuery.QueryProgress.OrderAndReconstructKeysARCQueryClassMemberPart 1:
ARCQuery.ValueComparerDateTime.TryGetPreviousARCQueryClassMemberSuggestion for previous query (browsing 'backwards')
ARCQuery.QueryProgress.GetHTMLLinksToIndividualQueryPartsARCQueryClassMemberIs able to generate the following:
ARCQuery.ValueComparerDateTime.TryGetNextARCQueryClassMemberSuggestion for next query (browsing 'forwards')
ARCQuery.QueryProgress.ToStringARCQueryClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCAPI.ResponseFormatARCAPIEnumThe response format, HTML or JSON, for an API request.
ARCQuery.Quantile.OCTILEARCQueryEnumMemberDivide into 8 parts
ARCAPI.ResponseFormat.JSONARCAPIEnumMember 
ARCQuery.Quantile.DECILEARCQueryEnumMemberDivide into 10 parts
ARCAPI.ResponseFormat.HTMLARCAPIEnumMember 
ARCQuery.Quantile.DUODECILEARCQueryEnumMemberDivide into 12 parts
Assembly AgoBrowse Assembly 
ARCQuery.Quantile.HEXADECILEARCQueryEnumMemberDivide into 16 parts
AgoBrowse.ProgramAgoBrowseClass 
ARCQuery.Quantile.VENTILEARCQueryEnumMemberDivide into 20 parts
AgoBrowse.Program.InitStreamProcessorAgoBrowseClassMemberInitializes stream processor.
ARCQuery.Quantile.PERCENTILEARCQueryEnumMemberDivide into 100 parts
AgoBrowse.RootAgoBrowseClassContains the user friendly welcome text (front page) for the application.
ARCQuery.Quantile.PERMILLEARCQueryEnumMemberDivide into 1000 parts
AgoBrowse.Root.ToHTMLSimpleSingleAgoBrowseClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCQuery.QueryProgressPARCQueryEnumDescribes class -QueryProgress-.
AgoBrowse.Root.TryGetPAgoBrowseClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCQuery.QueryProgressP.TitleARCQueryEnumMemberThe title to be used in the final presentation of the query result.
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).
ARCQuery.QueryProgressP.QueriesARCQueryEnumMember 
AgoBrowse.Root.ToStringAgoBrowseClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryProgressP.StrCurrentTypeARCQueryEnumMemberNormally the -ToStringVeryShort- representation of the type of objects in the -Result- collection.
AgoBrowse.Controllers.CompileControllerAgoBrowseClassCompiles a hierarchical 'picture book' from the requested position in the -DataStorage-.
ARCQuery.QueryProgressP.CurrentStrictnessARCQueryEnumMemberDescribes -Strictness- ON / OFF when executing query.
AgoBrowse.Controllers.CompileController.APIMethodAgoBrowseClassMemberThe (only) API method that this controller supports.
ARCQuery.QueryProgressP.CreateHintsARCQueryEnumMemberDescribes if hints are to be generated (as query progresses) for new queries.
AgoBrowse.Controllers.CompileController.CompileAgoBrowseClassMemberCompiles a hierarchical 'picture book' from the given parameter.
ARCQuery.QueryProgressP.UseCacheARCQueryEnumMemberDescribes if cache is to be used or not.
AgoBrowse.Controllers.CompileController.ToStringAgoBrowseClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryProgressP.LinkAdjustmentARCQueryEnumMemberExperimental: Adjustment to be done by -QueryProgress-.- ToHTMLSimpleSingle- (when it ascertains how to go back to root level).
AgoBrowse.Controllers.ControllerFacadeAgoBrowseClassFacade for entry into the desired -RQController-.
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.
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload2AgoBrowseClassMemberCatches all HTTP GET requests to this API.
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.
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload1AgoBrowseClassMemberCatches all HTTP POST requests to this API.
ARCQuery.QueryProgressP.AllLogEntriesForThisQueryARCQueryEnumMember 
Namespace ARCCore NamespaceA necessary library (.DLL in Windows terms) that every -ARNodeType- should link to.
ARCQuery.TranslationsPARCQueryEnumThis enum has no values because the keys are the actual string to be translated.
Namespace ARCDoc NamespaceA library supporting documentation and demonstrating usage of AgoRapide.
ARCQuery.TranslationSinglePARCQueryEnumDescribes class -TranslationSingle-.
Namespace ARCQuery NamespaceARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
ARCQuery.TranslationSingleP.TextARCQueryEnumMember 
Namespace ARCAPI NamespaceA library providing an API on top of the -PropertyStream-.
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.
Namespace AgoBrowse Namespace 
ARCQuery.EntityMethodKey+MethodTypeARCQueryEnumExplains type of method signature found (trough reflection) for corresponding entity class.
Namespace AgoBrowse.Controllers Namespace 
ARCQuery.EntityMethodKey+MethodType.SimpleARCQueryEnumMemberSignature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)'
ARCQuery.EntityMethodKey+MethodType.ComplexARCQueryEnumMemberSignature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)'
ARCQuery.QueryExpressionWhere+WildcardPositionTypeARCQueryEnumPosition of wildcard in value, like '*ABC' (-AtStart-), 'ABC*' (-AtEnd-) and
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStartARCQueryEnumMemberExample: '*ABC'.
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtEndARCQueryEnumMemberExample: 'ABC*'.
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStartAndEndARCQueryEnumMemberExample: '*ABC*'.
ARCQuery.QueryExpressionWhere+ValueEnumARCQueryEnumHelper enum used internally by -QueryExpressionWhere- in order to represent queries like WHERE Name = NULL, WHERE Name = NOTNULL and WHERE Name = * (ALL).
ARCQuery.QueryExpressionWhere+ValueEnum.NULLARCQueryEnumMember 
ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULLARCQueryEnumMemberPractical value enabling suggestions from -GetPrevious- and -GetNext-.
ARCAPI.BaseController.GetTimestampIsOldWarningHTMLARCAPIClassMemberIf -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format.
ARCAPI.BaseController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCAPI.EditControllerARCAPIClassOffers a simple HTML editing environment of the raw -PropertyStream- from the given key.
ARCAPI.EditController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCAPI.EditController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCAPI.GQControllerARCAPIClassOffers GraphQL queries.
ARCAPI.GQController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCAPI.GQController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCAPI.RQControllerARCAPIClassRQ = REST Query. Executes a REST like query request against the given -DataStorage-.
ARCAPI.RQController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCAPI.RQController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCAPI.DataStorageARCAPIClassThe all-in-memory global application data storage.
ARCAPI.DataStorage.CreateARCAPIClassMemberCreates a -DataStorage- instance with default parameters.
ARCAPI.DataStorage..ctorARCAPIClassMemberThis method will:
ARCAPI.DataStorage.StorageARCAPIClassMemberThe actual storage.
ARCAPI.DataStorage.ControllerStorageARCAPIClassMemberUsually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]).
ARCAPI.DataStorage.DocLinksARCAPIClassMemberNote that may be null.
ARCAPI.DataStorage.LockARCAPIClassMemberLocking object for thread-safe access from simultaneous API requests.
ARCAPI.DataStorage.ExternalReceiverARCAPIClassMemberTypically used by -AddController-.
ARCAPI.DataStorage.DoNotStoreInternallyARCAPIClassMemberTypically used by -AddController-.
ARCAPI.BaseControllerPARCAPIEnumDescribes class -BaseController-.
ARCAPI.BaseControllerP.CountRequestARCAPIEnumMemberNumber of calls to -APIMethod- since application initialization
ARCAPI.BaseControllerP.CountExceptionARCAPIEnumMemberNumber of exceptions at call to -APIMethod- since application initialization
ARCAPI.BaseControllerP.LogLevelARCAPIEnumMember 

Generated 2025-09-23 21:34:57.189 UTC