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

130 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCAPI.RQController	ARCAPI	Class	RQ = REST Query. Executes a REST like query request against the given -DataStorage-.
ARCAPI.RQController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCAPI.RQController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCAPI.DataStorage	ARCAPI	Class	The all-in-memory global application data storage.
ARCAPI.DataStorage.Create	ARCAPI	ClassMember	Creates a -DataStorage- instance with default parameters.
ARCAPI.DataStorage..ctor	ARCAPI	ClassMember	This method will:
ARCAPI.DataStorage.Storage	ARCAPI	ClassMember	The actual storage.
ARCAPI.DataStorage.ControllerStorage	ARCAPI	ClassMember	Usually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]).
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
AgoMail.EmailP.TextBody	AgoMail	EnumMember
AgoMail.EmailP.HTMLBody	AgoMail	EnumMember
AgoMail.EmailP.Headers	AgoMail	EnumMember
AgoMail.EmailP.Attachments	AgoMail	EnumMember
Namespace ARCCore		Namespace	A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to.
Namespace ARCDoc		Namespace	A library supporting documentation and demonstrating usage of AgoRapide.
Namespace ARCQuery		Namespace	ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
Namespace ARCAPI		Namespace	A library providing an API on top of the -PropertyStream-.
Namespace AgoMail		Namespace
Namespace AgoMail.Controllers		Namespace
ARCCore.StreamProcessorP.IncomingConnectionsPortNo	ARCCore	EnumMember	If not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-).
ARCQuery.QueryExpressionTake.SyntaxHelp	ARCQuery	ClassMember	TAKE {Count}
ARCCore.StreamProcessorP.UnderClosure	ARCCore	EnumMember	Set to TRUE if to be closed, whenever an exception occurs or when class goes out of scope
ARCQuery.QueryExpressionWhere	ARCQuery	Class	Executes a 'WHERE {key} {operator} {value}' against the given collection.
ARCCore.StreamProcessorP.WriteToConsole	ARCCore	EnumMember	If true then incoming data (from other nodes will be written to console.
ARCQuery.QueryExpressionWhere.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCCore.StreamProcessorP.Timestamp	ARCCore	EnumMember	The timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-.
ARCQuery.QueryExpressionWhere.IsMatch	ARCQuery	ClassMember	Returns TRUE if property matches criteria.
ARCCore.StreamProcessorP.TimestampIsOld	ARCCore	EnumMember	A warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date.
ARCQuery.QueryExpressionWhere.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCCore.StreamProcessorP.TimestampResolution	ARCCore	EnumMember	The time interval between each timestamp update in the -PropertyStream-.
ARCQuery.QueryExpressionWhere.SyntaxHelp	ARCQuery	ClassMember	WHERE {key} {operator} {value}
ARCCore.StreamProcessorP.DoNotStoreLocally	ARCCore	EnumMember	For -Client-, incoming data (as received from a -Outgoing-) is possible to store BOTH to disk, AND to (normally) a -PRich-.
ARCQuery.QueryExpressionWhere.Value	ARCQuery	ClassMember	The Value should ideally be as strongly typed as possible. Note that it may be of type -ValueEnum- relevant for queries like WHERE Name = NULL.
ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocally	ARCCore	EnumMember	Means 'do not store local origin locally but wait until it gets confirmed by core storage'.
ARCQuery.QueryProgress	ARCQuery	Class	Keeps track of execution of query (that is, a query consisting of multiple -QueryExpression-), and also stores final result.
ARCCore.StreamProcessorP.CacheDiskWrites	ARCCore	EnumMember	If TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance.
ARCQuery.QueryProgress.ToJSONSerializeable	ARCQuery	ClassMember	Override of default interface method -ToJSONSerializeable- is necessary because resulting data is 'hidden' within -Result-.
ARCCore.StreamProcessorP.CopyFileStructureFromCore	ARCCore	EnumMember	If TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-).
ARCQuery.QueryProgress.PreviousQueryJustExecuted	ARCQuery	ClassMember	TODO: This is somewhat loosely associated.
ARCCore.StreamProcessorP.CountIncomingConnections	ARCCore	EnumMember
ARCQuery.QueryProgress.NextQueryToExecute	ARCQuery	ClassMember	TODO: This is somewhat loosely associated.
ARCCore.StreamProcessorP.CountOutgoingConnections	ARCCore	EnumMember
ARCQuery.QueryProgress.ToHTMLSimpleSingle	ARCQuery	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCCore.StreamProcessorP.CountOutsideLocalReceiver	ARCCore	EnumMember	Count of calls to -OutsideLocalReceiver-.
ARCQuery.QueryProgress.OrderAndReconstructKeys	ARCQuery	ClassMember	Part 1:
ARCCore.StreamProcessorP.CountReceiveLocalOrigin	ARCCore	EnumMember	Count of -PropertyStreamLine- with -HasLocalOrigin-.
ARCQuery.QueryProgress.GetHTMLLinksToIndividualQueryParts	ARCQuery	ClassMember	Is able to generate the following:
ARCCore.StreamProcessorP.CountReceiveNonLocalOrigin	ARCCore	EnumMember	Count of -PropertyStreamLine- not with -HasLocalOrigin-.
ARCQuery.QueryProgress.ToString	ARCQuery	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCCore.StorageFileP	ARCCore	Enum	Describes class -StorageFile-.
ARCQuery.QueryProgress.Result	ARCQuery	ClassMember	This gets updated continously as the different query expressions get evaluated.
ARCCore.StorageFileP.Filename	ARCCore	EnumMember
ARCQuery.QueryProgress.ExecutedQueries	ARCQuery	ClassMember	The result from calling -Execute- for each query in -Queries-.
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.QueryProgress.AdditionalJavascriptUrlEncoder	ARCQuery	ClassMember	Returns the Javascript code for converting characters that are difficult to pass in URLs to a format understood by -Decode-.
ARCCore.ConnectionDirection	ARCCore	Enum	The concept of who took the initiative for the connections (who asked to open the TCP/IP session).
ARCQuery.UtilQuery	ARCQuery	Class	Utility methods for -ARCQuery-.
ARCCore.ConnectionDirection.Incoming	ARCCore	EnumMember	ConnectionInstruction will not be set for these.
ARCQuery.UtilQuery.IndexOfOutsideOf	ARCQuery	ClassMember	Equivalent to string.IndexOf except that any character encountered inside pairs of the 'outsideOf'-char are not counted.
ARCCore.ConnectionDirection.Outgoing	ARCCore	EnumMember	There would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-:
ARCQuery.UtilQuery.IndexOfAnyOutsideOf	ARCQuery	ClassMember	Equivalent to string.IndexOfAny except that any character encountered inside pairs of the 'outsideOf'-char are not counted.
ARCCore.DataTransferDirection	ARCCore	Enum	Direction for transfer of data.
ARCQuery.UtilQuery.SplitOutsideOf	ARCQuery	ClassMember	Equivalent to string.Split except that any character encountered inside pairs of the 'outsideOf'-char are not counted as separators.
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.UtilQuery.SpecialLinkPrefixes	ARCQuery	ClassMember	Contains prefixes for which links (see -LinkInsertionInDocumentation-) are also desired without the prefix.
ARCCore.DataTransferDirection.Receive	ARCCore	EnumMember	Like -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-.
ARCQuery.ValueComparer	ARCQuery	Class	Can evaluation expressions like 'WHERE Created = ThisYear.
ARCCore.TPropertyKeyEnum	ARCCore	Enum	Placeholder for any enum type suitable as generic type parameter for -PExact-.
Assembly ARCDoc		Assembly	A library supporting documentation and demonstrating usage of AgoRapide.
ARCDoc.Apple	ARCDoc	Class	The most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-.
ARCDoc.Apple.AddName	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCDoc.Apple.GetName	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCDoc.Apple.TryGetName	ARCDoc	ClassMember	Convenience method, not obligatory.
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).
ARCDoc.Apple.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.Apple.Name	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCDoc.Banana	ARCDoc	Class	Implements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency.
ARCDoc.Banana.Name	ARCDoc	ClassMember	Annotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
ARCDoc.Banana.Colour	ARCDoc	ClassMember	Annotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
ARCDoc.Demonstrator	ARCDoc	Class	Demonstrates various concepts from -ARCCore-, especially -PropertyAccess-.
ARCDoc.Demonstrator.DemonstratePropertyAccessApple	ARCDoc	ClassMember	Demonstrates use of -PropertyAccess- through the -Apple- class.
ARCDoc.Demonstrator.DemonstratePropertyAccessOrange	ARCDoc	ClassMember	Demonstrates use of -PropertyAccess- through the -Orange- class.
ARCDoc.Demonstrator.DemonstratePropertyAccessBanana	ARCDoc	ClassMember	Demonstrates use of -PropertyAccess- through the -Banana- class.
ARCDoc.Demonstrator.DemonstrateITypeDescriber	ARCDoc	ClassMember	Demonstrates use of -ITypeDescriber- for describing single-property values.
ARCDoc.Demonstrator.DemonstratePRichHierarchicalStorage	ARCDoc	ClassMember	Demonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage.
ARCDoc.Demonstrator.DemonstratePropertyStream	ARCDoc	ClassMember	Demonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console.
ARCDoc.Demonstrator.DemonstrateBareBonesClient	ARCDoc	ClassMember	Demonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET.
ARCDoc.Demonstrator.DemonstrateLogConsole	ARCDoc	ClassMember	Demonstrates a quite simple log console.
ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClient	ARCDoc	ClassMember	Demonstrates use of -StreamProcessor- as a general client.
ARCDoc.Orange	ARCDoc	Class	Inherits -PExact- for probably the best compromise between memory consumption and easy of development.
ARCDoc.Orange.Name	ARCDoc	ClassMember	See -Name- for more information.
ARCDoc.Orange.Storage	ARCDoc	ClassMember	Uses int-value of -__enum- minus 1 as index.
ARCDoc.SomeAppComponent	ARCDoc	Class	Demonstrates how also your actual application classes, not only your data classes, should implement -IP-.
ARCDoc.SomeAppComponent.MethodC	ARCDoc	ClassMember	Note structured format in logging.
ARCDoc.SomeAppComponent.MethodD	ARCDoc	ClassMember	Same as MethodC- but returns data ('Func<string>()' instead of 'Action()')
ARCDoc.SomeAppComponent.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocFrag	ARCDoc	Class	DocFrag = Document fragment.
ARCDoc.DocFrag.Create Overload1	ARCDoc	ClassMember	Creates a -DocFrag- object representing an assembly or a namespace.
ARCDoc.DocFrag.Create Overload2	ARCDoc	ClassMember	Creates a -DocFrag- object representing a class, class member, enum or enum member.

Generated 2025-11-05 12:27:57.025 UTC