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

152 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCQuery.QueryProgressP.CurrentStrictnessARCQueryEnumMemberDescribes -Strictness- ON / OFF when executing query.
ARCQuery.QueryProgress.OrderAndReconstructKeysARCQueryClassMemberPart 1:
ARCQuery.FunctionKeyLengthARCQueryClassReturns length of (string) value of field, like 4 for 'John'.
ARCAPI.DataStorage..ctorARCAPIClassMemberThis method will:
ARCQuery.QueryProgressP.CreateHintsARCQueryEnumMemberDescribes if hints are to be generated (as query progresses) for new queries.
ARCQuery.QueryProgress.GetHTMLLinksToIndividualQueryPartsARCQueryClassMemberIs able to generate the following:
ARCQuery.FunctionKeyLength.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCAPI.DataStorage.StorageARCAPIClassMemberThe actual storage.
ARCQuery.QueryProgressP.UseCacheARCQueryEnumMemberDescribes if cache is to be used or not.
ARCQuery.QueryProgress.ToStringARCQueryClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.FunctionKeyLength.SyntaxHelpARCQueryClassMember'Length()'
ARCAPI.DataStorage.ControllerStorageARCAPIClassMemberUsually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]).
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.
ARCQuery.QueryProgress.ResultARCQueryClassMemberThis gets updated continously as the different query expressions get evaluated.
ARCQuery.FunctionKeyType.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCAPI.DataStorage.DocLinksARCAPIClassMemberNote that may be null.
ARCQuery.QueryProgress.ExecutedQueriesARCQueryClassMemberThe result from calling -Execute- for each query in -Queries-.
ARCQuery.FunctionKeyType.SyntaxHelpARCQueryClassMember'Type()'
ARCAPI.DataStorage.LockARCAPIClassMemberLocking object for thread-safe access from simultaneous API requests.
ARCQuery.QueryProgress.AdditionalJavascriptUrlEncoderARCQueryClassMemberReturns the Javascript code for converting characters that are difficult to pass in URLs to a format understood by -Decode-.
ARCQuery.FunctionKeyWeekARCQueryClassExtract week-number from field according to ISO 8601.
ARCAPI.DataStorage.ExternalReceiverARCAPIClassMemberTypically used by -AddController-.
ARCQuery.UtilQueryARCQueryClassUtility methods for -ARCQuery-.
ARCQuery.FunctionKeyWeek.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCAPI.DataStorage.DoNotStoreInternallyARCAPIClassMemberTypically used by -AddController-.
ARCQuery.UtilQuery.IndexOfOutsideOfARCQueryClassMemberEquivalent to string.IndexOf except that any character encountered inside pairs of the 'outsideOf'-char are not counted.
ARCQuery.FunctionKeyWeek.SyntaxHelpARCQueryClassMember'Week()'
ARCAPI.BaseControllerPARCAPIEnumDescribes class -BaseController-.
ARCQuery.UtilQuery.IndexOfAnyOutsideOfARCQueryClassMemberEquivalent to string.IndexOfAny except that any character encountered inside pairs of the 'outsideOf'-char are not counted.
ARCQuery.FunctionKeyYearARCQueryClassExtracts Year-component from field.
ARCAPI.BaseControllerP.CountRequestARCAPIEnumMemberNumber of calls to -APIMethod- since application initialization
ARCQuery.UtilQuery.SplitOutsideOfARCQueryClassMemberEquivalent to string.Split except that any character encountered inside pairs of the 'outsideOf'-char are not counted as separators.
ARCQuery.FunctionKeyYear.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCAPI.BaseControllerP.CountExceptionARCAPIEnumMemberNumber of exceptions at call to -APIMethod- since application initialization
ARCQuery.UtilQuery.SpecialLinkPrefixesARCQueryClassMemberContains prefixes for which links (see -LinkInsertionInDocumentation-) are also desired without the prefix.
ARCQuery.FunctionKeyYear.SyntaxHelpARCQueryClassMember'Year()'
ARCAPI.BaseControllerP.LogLevelARCAPIEnumMember 
ARCQuery.ValueComparerARCQueryClassCan evaluation expressions like 'WHERE Created = ThisYear.
ARCQuery.FunctionKeyYearMonthARCQueryClassExtracts Year + Month component from field like 2020-06.
ARCAPI.ResponseFormatARCAPIEnumThe response format, HTML or JSON, for an API request.
ARCQuery.ValueComparer.TryGetPreviousARCQueryClassMemberSuggestion for previous query (browsing 'backwards')
ARCQuery.FunctionKeyYearMonth.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCAPI.ResponseFormat.JSONARCAPIEnumMember 
ARCQuery.ValueComparer.TryGetNextARCQueryClassMemberSuggestion for next query (browsing 'forwards')
ARCQuery.FunctionKeyYearMonth.SyntaxHelpARCQueryClassMember'YearMonth()'
ARCAPI.ResponseFormat.HTMLARCAPIEnumMember 
ARCQuery.ValueComparerDateTimeARCQueryClass-ValueComparerDateTime- is an attempt at offering a human language interface for date and time queries.
ARCQuery.FunctionKeyYearQuarterARCQueryClassExtracts Year + Quarter component from field like 2020Q1.
Assembly AgoMail Assembly 
ARCQuery.ValueComparerDateTime.TryGetPreviousARCQueryClassMemberSuggestion for previous query (browsing 'backwards')
ARCQuery.FunctionKeyYearQuarter.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
AgoMail.CleanerAgoMailClass 
ARCQuery.ValueComparerDateTime.TryGetNextARCQueryClassMemberSuggestion for next query (browsing 'forwards')
ARCQuery.FunctionKeyYearQuarter.SyntaxHelpARCQueryClassMember'YearQuarter()'
AgoMail.Cleaner.CleanAgoMailClassMemberRemoves emails with often seen values for Subject, To or From.
ARCQuery.ValueComparerDateTime.TryParseARCQueryClassMemberNote: This parser is probably exhaustive but not necessarily logical
ARCQuery.FunctionKeyYearWeekARCQueryClassExtract year and week number from field according to ISO 8601 like '2021-51'
AgoMail.EmailAgoMailClass 
ARCQuery.ValueComparerDateTime.ResolutionARCQueryClassMemberSee -ResolutionEnum-.
ARCQuery.FunctionKeyYearWeek.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
AgoMail.Email.TryGetVAgoMailClassMemberNote 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.ValueComparerDateTime.StepsARCQueryClassMemberValue 0 would mean 'This', like ThisHour, Today, ThisMonth and so on.
ARCQuery.NewKeyGetType.QuantileKeyARCQueryClassMemberEventual final -QuantileKey- at end of compound key.
AgoMail.Email.ToStringAgoMailClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.NewKeyToPropertyStreamARCQueryClassReturns the -PropertyStream- representation of the given object.
AgoMail.ProgramAgoMailClassApplication startup and initialization
ARCQuery.NewKeyToPropertyStream.TryGetPInternalARCQueryClassMemberThe internal executor, containing the specific functionality for how to evaluate the key.
AgoMail.Program.InitStreamProcessorAgoMailClassMemberInitializes stream processor.
ARCQuery.NewKeyToPropertyStream.ToStringARCQueryClassMemberThe ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
AgoMail.RootAgoMailClassContains the user friendly welcome text (front page) for the application.
ARCQuery.NewKeyToPropertyStream.TryGetPARCQueryClassMemberThe outwards facing executor, understanding use of -FunctionKeys-.
AgoMail.Root.ToHTMLSimpleSingleAgoMailClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCQuery.NewKeyToPropertyStream.SyntaxHelpARCQueryClassMember'ToPropertyStream()'
AgoMail.Root.TryGetVAgoMailClassMemberNote 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.NewKeyToPropertyStream.FunctionKeysARCQueryClassMemberAll -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
AgoMail.Root.ToStringAgoMailClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.NewKeyToPropertyStream.QuantileKeyARCQueryClassMemberEventual final -QuantileKey- at end of compound key.
AgoMail.Controllers.ControllerFacadeAgoMailClassFacade for entry into the desired -BaseController-.
ARCQuery.QuantileKeyARCQueryClassCan separate entities into quantiles, like Quartiles, Quintiles or Sextiles.
AgoMail.Controllers.ControllerFacade.CatchAll Overload2AgoMailClassMemberCatches all HTTP GET requests to this API.
ARCQuery.QuantileKey.TryGetPARCQueryClassMemberReturns an integer with the number of the quantile group for the value returned by the given -CompoundKey-).
AgoMail.Controllers.ControllerFacade.CatchAll Overload1AgoMailClassMemberCatches all HTTP POST requests to this API.
ARCQuery.QuantileKey.TryParseARCQueryClassMemberNote that any value (positive integer greated than 2) is accepted, not necessarily only string-representations of enums within -Quantile-.
AgoMail.EmailPAgoMailEnum 
ARCQuery.QueryARCQueryClassKeeps track of progress of query, and the interim result.
AgoMail.EmailP.DateAgoMailEnumMemberUTC-format
ARCQuery.Query.ShouldTerminateARCQueryClassMemberAttempts to explain problem, in -TerminateReason- and by logging.
AgoMail.EmailP.FromAgoMailEnumMember 
ARCQuery.Query.ExecuteOneARCQueryClassMemberNOTE: Note how avoids deferred execution in order to always correctly time execution of each query element separately.
AgoMail.EmailP.ToAgoMailEnumMember 
ARCQuery.Query.AllLogEntriesForThisQueryARCQueryClassMemberTemporary storage of log information.
AgoMail.EmailP.CCAgoMailEnumMember 
ARCQuery.Query.ProgressARCQueryClassMemberUse of member class in order for -Query- not to inherit -IP-.
AgoMail.EmailP.SubjectAgoMailEnumMember 
ARCQuery.QueryExpressionLogARCQueryClassA debugging tool used to extract detailed log information about the execution of the query.
AgoMail.EmailP.TextBodyAgoMailEnumMember 
ARCQuery.QueryExpressionLog.ExecuteARCQueryClassMemberTransforms the given input collection into a resulting collection.
AgoMail.EmailP.HTMLBodyAgoMailEnumMember 
ARCQuery.QueryExpressionLog.TryCheckForExistenceOfKeyARCQueryClassMemberUsed by query expressions in order to catch wrong field names used or misspelling of field names.
AgoMail.EmailP.HeadersAgoMailEnumMember 
ARCQuery.QueryExpressionLog.SyntaxHelpARCQueryClassMember'Log'.
AgoMail.EmailP.AttachmentsAgoMailEnumMember 
ARCQuery.QueryExpressionOrderByARCQueryClassOrders collection.
Namespace ARCCore NamespaceA necessary library (.DLL in Windows terms) that every -ARNodeType- should link to.
ARCQuery.QueryExpressionOrderBy.ExecuteARCQueryClassMemberTransforms the given input collection into a resulting collection.
Namespace ARCDoc NamespaceA library supporting documentation and demonstrating usage of AgoRapide.
ARCQuery.QueryExpressionOrderBy.TryCheckForExistenceOfKeyARCQueryClassMemberUsed by query expressions in order to catch wrong field names used or misspelling of field names.
Namespace ARCQuery NamespaceARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
ARCQuery.QueryExpressionOrderBy.SyntaxHelpARCQueryClassMemberORDER BY {key} [DESC] / [ASC]
Namespace ARCAPI NamespaceA library providing an API on top of the -PropertyStream-.
ARCQuery.QueryExpressionOrderBy.KeyARCQueryClassMemberTODO: Expand syntax to include multiple keys
Namespace AgoMail Namespace 
ARCQuery.QueryExpressionPivotARCQueryClassCreates a table by querying over two keys like
Namespace AgoMail.Controllers Namespace 
ARCQuery.QueryExpressionPivot.ExecuteARCQueryClassMemberTransforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionPivot.GetCrossSummationCheckerARCQueryClassMemberReturns a cross sum checker for int, long, double, Timespan.
ARCQuery.QueryExpressionPivot.TryCheckForExistenceOfKeyARCQueryClassMemberUsed by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionPivot.SyntaxHelpARCQueryClassMember1) 'PIVOT {rowKey} BY {columnKey}' like "PIVOT Colour BY Production.Year"
ARCQuery.QueryExpressionPivot.AggregationTypeARCQueryClassMemberMost common value is -Count-, in which case -AggregationKey- may be correspondingly set to null.
ARCQuery.QueryExpressionPivot.AggregationKeyARCQueryClassMemberThis is often null (with -AggregationType- correspondingly set to Count-).
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.
ARCQuery.QueryProgressP.AllLogEntriesForThisQueryARCQueryEnumMember 
ARCQuery.EntityMethodKey+MethodTypeARCQueryEnumExplains type of method signature found (trough reflection) for corresponding entity class.
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+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-.
ARCQuery.QueryExpressionWhere+ValueEnum.ALLARCQueryEnumMemberEquivalent to query like WHERE Name = *
ARCQuery.ValueComparerDateTime+ResolutionEnumARCQueryEnum 
ARCQuery.ValueComparerDateTime+ResolutionEnum.SecondARCQueryEnumMember 
ARCQuery.ValueComparerDateTime+ResolutionEnum.MinuteARCQueryEnumMember 
ARCQuery.ValueComparerDateTime+ResolutionEnum.HourARCQueryEnumMember 
ARCQuery.ValueComparerDateTime+ResolutionEnum.DayARCQueryEnumMember 
ARCQuery.ValueComparerDateTime+ResolutionEnum.WeekARCQueryEnumMember 
ARCQuery.ValueComparerDateTime+ResolutionEnum.MonthARCQueryEnumMember 
ARCQuery.ValueComparerDateTime+ResolutionEnum.QuarterARCQueryEnumMember 
ARCQuery.ValueComparerDateTime+ResolutionEnum.YearARCQueryEnumMember 
Assembly ARCAPI AssemblyA library providing an API on top of the -PropertyStream-.
ARCAPI.ContentResultARCAPIClassMimicks Microsoft.AspNetCore.Mvc.ContentResult.
ARCAPI.ContentResult.CreateHTMLOKARCAPIClassMemberNOTE: Parameter must be a complete HTML page.
ARCAPI.ContentResult.CreateErrorARCAPIClassMemberTODO: Add a key / value format for error messages, like done for -Log-.
ARCAPI.AddControllerARCAPIClassParses and stores a -PropertyStreamLine-.
ARCAPI.AddController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
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).

Generated 2026-11-04 19:13:44.634 UTC