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

170 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCAPI.RQController	ARCAPI	Class	RQ = REST Query. Executes a REST like query request against the given -DataStorage-.
ARCQuery.Quantile.PERMILLE	ARCQuery	EnumMember	Divide into 1000 parts
ARCAPI.RQController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCQuery.QueryProgressP	ARCQuery	Enum	Describes class -QueryProgress-.
ARCAPI.RQController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryProgressP.Queries	ARCQuery	EnumMember
ARCAPI.DataStorage	ARCAPI	Class	The all-in-memory global application data storage.
ARCQuery.QueryProgressP.StrCurrentType	ARCQuery	EnumMember	Normally the -ToStringVeryShort- representation of the type of objects in the -Result- collection.
ARCAPI.DataStorage.Create	ARCAPI	ClassMember	Creates a -DataStorage- instance with default parameters.
ARCQuery.QueryProgressP.CurrentStrictness	ARCQuery	EnumMember	Describes -Strictness- ON / OFF when executing query.
ARCAPI.DataStorage..ctor	ARCAPI	ClassMember	This method will:
ARCQuery.QueryProgressP.CreateHints	ARCQuery	EnumMember	Describes if hints are to be generated (as query progresses) for new queries.
ARCAPI.DataStorage.Storage	ARCAPI	ClassMember	The actual storage.
ARCQuery.QueryProgressP.UseCache	ARCQuery	EnumMember	Describes if cache is to be used or not.
ARCAPI.DataStorage.ControllerStorage	ARCAPI	ClassMember	Usually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]).
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.
AgoMail.EmailP.TextBody	AgoMail	EnumMember
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.
AgoMail.EmailP.HTMLBody	AgoMail	EnumMember
ARCQuery.QueryProgressP.AllLogEntriesForThisQuery	ARCQuery	EnumMember
AgoMail.EmailP.Headers	AgoMail	EnumMember
ARCQuery.EntityMethodKey+MethodType	ARCQuery	Enum	Explains type of method signature found (trough reflection) for corresponding entity class.
AgoMail.EmailP.Attachments	AgoMail	EnumMember
ARCQuery.EntityMethodKey+MethodType.Simple	ARCQuery	EnumMember	Signature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)'
Namespace ARCCore		Namespace	A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to.
ARCQuery.EntityMethodKey+MethodType.Complex	ARCQuery	EnumMember	Signature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)'
Namespace ARCDoc		Namespace	A library supporting documentation and demonstrating usage of AgoRapide.
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).
Namespace ARCQuery		Namespace	ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
ARCQuery.QueryExpressionWhere+ValueEnum.NULL	ARCQuery	EnumMember
Namespace ARCAPI		Namespace	A library providing an API on top of the -PropertyStream-.
ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULL	ARCQuery	EnumMember	Practical value enabling suggestions from -GetPrevious- and -GetNext-.
Namespace AgoMail		Namespace
ARCQuery.QueryExpressionWhere+ValueEnum.ALL	ARCQuery	EnumMember	Equivalent to query like WHERE Name = *
Namespace AgoMail.Controllers		Namespace
ARCQuery.ValueComparerDateTime+ResolutionEnum	ARCQuery	Enum
ARCQuery.ValueComparerDateTime+ResolutionEnum.Second	ARCQuery	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum.Minute	ARCQuery	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum.Hour	ARCQuery	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum.Day	ARCQuery	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum.Week	ARCQuery	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum.Month	ARCQuery	EnumMember
ARCAPI.DataStorage.DocLinks	ARCAPI	ClassMember	Note that may be null.
ARCAPI.DataStorage.Lock	ARCAPI	ClassMember	Locking object for thread-safe access from simultaneous API requests.
ARCAPI.DataStorage.ExternalReceiver	ARCAPI	ClassMember	Typically used by -AddController-.
ARCAPI.DataStorage.DoNotStoreInternally	ARCAPI	ClassMember	Typically used by -AddController-.
ARCAPI.BaseControllerP	ARCAPI	Enum	Describes class -BaseController-.
ARCAPI.BaseControllerP.CountRequest	ARCAPI	EnumMember	Number of calls to -APIMethod- since application initialization
ARCAPI.BaseControllerP.CountException	ARCAPI	EnumMember	Number of exceptions at call to -APIMethod- since application initialization
ARCAPI.BaseControllerP.LogLevel	ARCAPI	EnumMember
ARCAPI.ResponseFormat	ARCAPI	Enum	The response format, HTML or JSON, for an API request.
ARCAPI.ResponseFormat.JSON	ARCAPI	EnumMember
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-.
AgoMail.Controllers.ControllerFacade.CatchAll Overload2	AgoMail	ClassMember	Catches all HTTP GET requests to this API.
AgoMail.Controllers.ControllerFacade.CatchAll Overload1	AgoMail	ClassMember	Catches all HTTP POST requests to this API.
AgoMail.EmailP	AgoMail	Enum
AgoMail.EmailP.Date	AgoMail	EnumMember	UTC-format
AgoMail.EmailP.From	AgoMail	EnumMember
AgoMail.EmailP.To	AgoMail	EnumMember
AgoMail.EmailP.CC	AgoMail	EnumMember
AgoMail.EmailP.Subject	AgoMail	EnumMember
ARCCore.PP.Valid	ARCCore	EnumMember	Timestamp when property was last known to be (still) valid
ARCCore.PP.Vid	ARCCore	EnumMember	Validator id, that is entity which set -Valid- for this property.
ARCCore.PP.Invalid	ARCCore	EnumMember	Timestamp when property was invalidated / 'deleted'.
ARCCore.PP.Iid	ARCCore	EnumMember	Invalidator id, that is entity which set -Invalid- for this property (or removed / 'undid' the invalidation by setting the value to '0001-01-01').
ARCCore.PP.ExceptionText	ARCCore	EnumMember	General property for logging of exceptions, usually set through -HandleException-.
ARCCore.PConcurrentP	ARCCore	Enum	Describes class -PConcurrent-.
ARCCore.PConcurrentP.Heartbeat	ARCCore	EnumMember
ARCCore.ActualConnectionP	ARCCore	Enum	Describes class -ActualConnection-.
ARCCore.ConnectionInstructionP.ServerPortNo	ARCCore	EnumMember	The port number for which to connect.
ARCCore.ConnectionInstructionP.ConnectionId	ARCCore	EnumMember	Usually a combination of -ClientId-, -ServerHostName- and -ServerPortNo-.
ARCCore.ConnectionInstructionP.DataTransferDirection	ARCCore	EnumMember
ARCCore.ConnectionInstructionP.Subscription	ARCCore	EnumMember	The actual subscripton. This is what the connecting party / (downstream) client would send over its TCP/IP connection to the (upstream) server.
ARCCore.ConnectionInstructionP.MultipleConnectionUsage	ARCCore	EnumMember
ARCCore.ConnectionInstructionP.Sharding	ARCCore	EnumMember
ARCCore.MultipleConnectionUsage	ARCCore	Enum	Enables fault-tolerance by describing use of multiple connections
ARCCore.MultipleConnectionUsage.Admin	ARCCore	EnumMember	Connection is a special administrative connection to a central 'command-and-control' server which instructs which connections to make.
ARCCore.MultipleConnectionUsage.RoundRobin	ARCCore	EnumMember	This connection to be used in a turn based system, together with other connections with -RoundRobin-.
ARCCore.MultipleConnectionUsage.Simultaneous	ARCCore	EnumMember	This connection to be used simultaneously with other connections with -Simultaneous-
ARCCore.StreamProcessorP	ARCCore	Enum	Describes class -StreamProcessor-.
ARCCore.StreamProcessorP.LocalStorageFolder	ARCCore	EnumMember	The local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar
ARCCore.StreamProcessorP.IndividualStorageFileSize	ARCCore	EnumMember	Max size (in bytes) for a single storage file before a new file is created by call to -StreamProcessor.CreateNewStorageFile-.
ARCCore.StreamProcessorP.CurrentlyInitializing	ARCCore	EnumMember	Set to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them).
ARCCore.StreamProcessorP.ClientUpdatePositionPath	ARCCore	EnumMember	Complete path to file containing -ClientUpdatePosition-.
ARCQuery.FunctionKeyTMB.SyntaxHelp	ARCQuery	ClassMember	'TMB()'
ARCCore.StreamProcessorP.ClientUpdatePosition	ARCCore	EnumMember	Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCQuery.FunctionKeyTotalHours	ARCQuery	Class	Converts a timespan to total hours (as an integer).
ARCCore.StorageFileP.Filename	ARCCore	EnumMember
ARCQuery.FunctionKeyTotalHours.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCCore.StorageFileP.Hash	ARCCore	EnumMember	Hash of storage file. Not implemented as of Apr 2020. It is envisaged to store hash-value as last line in storage file. In this case the hash must be the hash of the file excluding the last line
ARCQuery.FunctionKeyTotalHours.SyntaxHelp	ARCQuery	ClassMember	'TotalHours()'
ARCCore.ConnectionDirection	ARCCore	Enum	The concept of who took the initiative for the connections (who asked to open the TCP/IP session).
ARCQuery.FunctionKeyTotalMinutes	ARCQuery	Class	Converts a timespan to total minutes (as an integer).
ARCCore.ConnectionDirection.Incoming	ARCCore	EnumMember	ConnectionInstruction will not be set for these.
ARCQuery.FunctionKeyTotalMinutes.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCCore.ConnectionDirection.Outgoing	ARCCore	EnumMember	There would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-:
ARCQuery.FunctionKeyTotalMinutes.SyntaxHelp	ARCQuery	ClassMember	'TotalMinutes()'
ARCCore.DataTransferDirection	ARCCore	Enum	Direction for transfer of data.
ARCQuery.FunctionKeyType	ARCQuery	Class	Returns the type of a property.
ARCCore.DataTransferDirection.Send	ARCCore	EnumMember	Like -Client- sending in-application generated properties to -ArmDB- / -CoreDB- or -ArmDB- sending data received over an incoming connection to -CoreDB-.
ARCQuery.FunctionKeyType.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCCore.DataTransferDirection.Receive	ARCCore	EnumMember	Like -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-.
ARCQuery.FunctionKeyType.SyntaxHelp	ARCQuery	ClassMember	'Type()'
ARCCore.TPropertyKeyEnum	ARCCore	Enum	Placeholder for any enum type suitable as generic type parameter for -PExact-.
ARCQuery.FunctionKeyWeek	ARCQuery	Class	Extract week-number from field according to ISO 8601.
Assembly ARCDoc		Assembly	A library supporting documentation and demonstrating usage of AgoRapide.
ARCQuery.FunctionKeyWeek.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCDoc.Apple	ARCDoc	Class	The most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-.
ARCQuery.FunctionKeyWeek.SyntaxHelp	ARCQuery	ClassMember	'Week()'
ARCDoc.Apple.AddName	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCQuery.FunctionKeyYear	ARCQuery	Class	Extracts Year-component from field.
ARCDoc.Apple.GetName	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCQuery.FunctionKeyYear.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCDoc.Apple.TryGetName	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCQuery.FunctionKeyYear.SyntaxHelp	ARCQuery	ClassMember	'Year()'
ARCDoc.Apple.TryGetV	ARCDoc	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).
ARCQuery.FunctionKeyYearMonth	ARCQuery	Class	Extracts Year + Month component from field like 2020-06.
ARCDoc.Apple.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCQuery.FunctionKeyYearMonth.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.FunctionKeyYearMonth.SyntaxHelp	ARCQuery	ClassMember	'YearMonth()'
ARCQuery.FunctionKeyYearQuarter	ARCQuery	Class	Extracts Year + Quarter component from field like 2020Q1.
ARCQuery.FunctionKeyYearQuarter.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.FunctionKeyYearQuarter.SyntaxHelp	ARCQuery	ClassMember	'YearQuarter()'
ARCQuery.FunctionKeyYearWeek	ARCQuery	Class	Extract year and week number from field according to ISO 8601 like '2021-51'
ARCQuery.FunctionKeyYearWeek.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.NewKeyGetType.QuantileKey	ARCQuery	ClassMember	Eventual final -QuantileKey- at end of compound key.
ARCQuery.NewKeyToPropertyStream	ARCQuery	Class	Returns the -PropertyStream- representation of the given object.
ARCQuery.NewKeyToPropertyStream.TryGetPInternal	ARCQuery	ClassMember	The internal executor, containing the specific functionality for how to evaluate the key.
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.NewKeyToPropertyStream.TryGetP	ARCQuery	ClassMember	The outwards facing executor, understanding use of -FunctionKeys-.
ARCQuery.NewKeyToPropertyStream.SyntaxHelp	ARCQuery	ClassMember	'ToPropertyStream()'
ARCQuery.NewKeyToPropertyStream.FunctionKeys	ARCQuery	ClassMember	All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCQuery.NewKeyToPropertyStream.QuantileKey	ARCQuery	ClassMember	Eventual final -QuantileKey- at end of compound key.
ARCQuery.QuantileKey	ARCQuery	Class	Can separate entities into quantiles, like Quartiles, Quintiles or Sextiles.
ARCQuery.QuantileKey.TryGetP	ARCQuery	ClassMember	Returns an integer with the number of the quantile group for the value returned by the given -CompoundKey-).
ARCQuery.QuantileKey.TryParse	ARCQuery	ClassMember	Note that any value (positive integer greated than 2) is accepted, not necessarily only string-representations of enums within -Quantile-.
ARCQuery.Query	ARCQuery	Class	Keeps track of progress of query, and the interim result.
ARCQuery.Query.ShouldTerminate	ARCQuery	ClassMember	Attempts to explain problem, in -TerminateReason- and by logging.
ARCQuery.Query.ExecuteOne	ARCQuery	ClassMember	NOTE: Note how avoids deferred execution in order to always correctly time execution of each query element separately.
ARCQuery.Query.AllLogEntriesForThisQuery	ARCQuery	ClassMember	Temporary storage of log information.
ARCQuery.Query.Progress	ARCQuery	ClassMember	Use of member class in order for -Query- not to inherit -IP-.
ARCQuery.QueryExpression	ARCQuery	Class	Represents part of a query (or actually a transformation) against a given collection and the data storage from which it was taken.
ARCQuery.QueryExpression.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpression.AddParser	ARCQuery	ClassMember	Adds a -ApplicationSpecificCode- parser.
ARCQuery.QueryExpression.TryParse	ARCQuery	ClassMember	Find parsers from -Parsers- based on first word in query.
ARCQuery.QueryExpression.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpression.Parsers	ARCQuery	ClassMember	Parsers for all the relevant sub classes of -QueryExpression-.
ARCQuery.QueryExpressionWithSuggestions	ARCQuery	Class	Keeps track as each query item gets executed.
ARCQuery.QueryExpressionWithSuggestions.Previous	ARCQuery	ClassMember	Suggestion for a 'browse backwards' button.
ARCQuery.QueryExpressionWithSuggestions.Next	ARCQuery	ClassMember	Suggestion for a 'browse forwards' button.
ARCQuery.QueryExpressionAggregate	ARCQuery	Class	Aggregates over the given key.
ARCQuery.QueryExpressionAggregate.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionAggregate.IsSuitableAggregator	ARCQuery	ClassMember	Returns true if
ARCQuery.QueryExpressionAggregate.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionAggregate.SyntaxHelp	ARCQuery	ClassMember	1) 'AGGREGATE {rowKey}' like "AGGREGATE Product"
ARCQuery.QueryExpressionAggregate.AggregationType	ARCQuery	ClassMember	Most common value is -Count-, in which case -AggregationKey- may be correspondingly set to null.
ARCQuery.QueryExpressionAggregate.AggregationKey	ARCQuery	ClassMember	This is often null (with -AggregationType- correspondingly set to Count-).

Generated 2025-11-08 22:14:26.803 UTC