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

169 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
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.
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.
ARCQuery.QueryProgressP.AllLogEntriesForThisQuery	ARCQuery	EnumMember
ARCQuery.TranslationsP	ARCQuery	Enum	This enum has no values because the keys are the actual string to be translated.
ARCQuery.TranslationSingleP	ARCQuery	Enum	Describes class -TranslationSingle-.
ARCQuery.TranslationSingleP.Text	ARCQuery	EnumMember
ARCQuery.TranslationSingleP.IsMissing	ARCQuery	EnumMember	Value TRUE indicates that the Text given is simply the original key, in other words, the translation for the key is actually missing.
ARCQuery.EntityMethodKey+MethodType	ARCQuery	Enum	Explains type of method signature found (trough reflection) for corresponding entity class.
ARCQuery.EntityMethodKey+MethodType.Simple	ARCQuery	EnumMember	Signature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)'
AgoBrowse.Root.TryGetP	AgoBrowse	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
AgoBrowse.Root.TryGetV	AgoBrowse	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).
AgoBrowse.Root.ToString	AgoBrowse	ClassMember	TODO: Decide on what we actually want with ToString for this class.
AgoBrowse.Controllers.CompileController	AgoBrowse	Class	Compiles a hierarchical 'picture book' from the requested position in the -DataStorage-.
AgoBrowse.Controllers.CompileController.APIMethod	AgoBrowse	ClassMember	The (only) API method that this controller supports.
AgoBrowse.Controllers.CompileController.Compile	AgoBrowse	ClassMember	Compiles a hierarchical 'picture book' from the given parameter.
AgoBrowse.Controllers.CompileController.ToString	AgoBrowse	ClassMember	TODO: Decide on what we actually want with ToString for this class.
AgoBrowse.Controllers.ControllerFacade	AgoBrowse	Class	Facade for entry into the desired -RQController-.
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload2	AgoBrowse	ClassMember	Catches all HTTP GET requests to this API.
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload1	AgoBrowse	ClassMember	Catches all HTTP POST requests to this API.
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 AgoBrowse		Namespace
Namespace AgoBrowse.Controllers		Namespace
ARCQuery.QueryExpressionWhere+ValueEnum.ALL	ARCQuery	EnumMember	Equivalent to query like WHERE Name = *
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
ARCQuery.ValueComparerDateTime+ResolutionEnum.Quarter	ARCQuery	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum.Year	ARCQuery	EnumMember
Assembly ARCAPI		Assembly	A library providing an API on top of the -PropertyStream-.
ARCAPI.ContentResult	ARCAPI	Class	Mimicks Microsoft.AspNetCore.Mvc.ContentResult.
ARCAPI.ContentResult.CreateHTMLOK	ARCAPI	ClassMember	NOTE: Parameter must be a complete HTML page.
ARCAPI.ContentResult.CreateError	ARCAPI	ClassMember	TODO: Add a key / value format for error messages, like done for -Log-.
ARCAPI.AddController	ARCAPI	Class	Parses and stores a -PropertyStreamLine-.
ARCAPI.AddController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCAPI.AddController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCAPI.AddController.AllowFilter	ARCAPI	ClassMember	Describes what data is allowed to change through a list of -Subscription- instances.
ARCAPI.BaseController	ARCAPI	Class	Contains basic functionality for serving API methods.
ARCAPI.BaseController.BuildControllerStorage	ARCAPI	ClassMember	Builds a collection of 'std' (standard) controller instances to use for serving API requests.
ARCAPI.BaseController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCAPI.BaseController.CatchAll	ARCAPI	ClassMember	Serves the typical single generic API method in an AgoRapide API.
ARCAPI.BaseController.TryNavigateToLevelInDataStorage	ARCAPI	ClassMember	Navigates to the specified level (usually within -Storage-).
ARCAPI.BaseController.GetFormatAndAdjustRequest	ARCAPI	ClassMember	Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).
ARCAPI.BaseController.GetTimestampIsOldWarningHTML	ARCAPI	ClassMember	If -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format.
ARCAPI.BaseController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCAPI.EditController	ARCAPI	Class	Offers a simple HTML editing environment of the raw -PropertyStream- from the given key.
ARCAPI.EditController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCAPI.EditController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCAPI.GQController	ARCAPI	Class	Offers GraphQL queries.
ARCAPI.GQController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCAPI.GQController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
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 AgoBrowse		Assembly
AgoBrowse.Program	AgoBrowse	Class
AgoBrowse.Program.InitStreamProcessor	AgoBrowse	ClassMember	Initializes stream processor.
AgoBrowse.Root	AgoBrowse	Class	Contains the user friendly welcome text (front page) for the application.
AgoBrowse.Root.ToHTMLSimpleSingle	AgoBrowse	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCCore.ARConcepts.DataRetention	ARCCore	EnumMember	The concept of when to delete old data (if deemed necessary).
ARCCore.ARConcepts.NoRealDeletion	ARCCore	EnumMember	AgoRapide has no real concept for deletion of data (apart from -DataRetention-, which is mostly relevant for 'old' data).
ARCCore.ARConcepts.ManyToManyRelations	ARCCore	EnumMember	-ARCQuery- supports many-to-many relations in a simple manner without introducing a third entity type (a third table).
ARCCore.ARConcepts.Documentation	ARCCore	EnumMember	Thanks to the tagging of enums and classes in AgoRapide (like this description), automatically generation of documentation is possible.
ARCCore.ARConcepts.AssertionsAndDetailedExceptionMessages	ARCCore	EnumMember	The abstraction level in AgoRapide is very high.
ARCCore.ARConcepts.ExposingApplicationState	ARCCore	EnumMember	The traditional debugging process usually entails reading through logs and querying about your application state through a debugging tool.
ARCCore.ARConcepts.LinkInsertionInDocumentation	ARCCore	EnumMember	Documentation with links is much easier to read.
ARCCore.ARConcepts.TryPatternAndNull	ARCCore	EnumMember	AgoRapide uses non-nullable reference types as default throughout the system
ARCCore.PSPrefix.ES	ARCCore	EnumMember	ES = Event Stream (see -EventStream-).
ARCCore.PSPrefix.cmd	ARCCore	EnumMember	Command.
ARCCore.PSPrefix.app	ARCCore	EnumMember	Application state, like app/
ARCCore.PSPrefix.doc	ARCCore	EnumMember	Documentation.
ARCCore.PSPrefix.t	ARCCore	EnumMember	Translations.
ARCCore.PKHTMLAttributeP	ARCCore	Enum	Describes class -PKRelAttribute-.
ARCCore.PKHTMLAttributeP.Encoder	ARCCore	EnumMember	The class doing the HTML-encoding.
ARCCore.PKLogAttributeP	ARCCore	Enum	Describes class -PKLogAttribute.
ARCCore.PKLogAttributeP.DoNotLogAtAll	ARCCore	EnumMember	Originates from -DoNotLogAtAll-.
ARCCore.PKLogAttributeP.CountInterval	ARCCore	EnumMember	For a value of n, log only every n'th time the property is changed.
ARCCore.PKLogAttributeP.TimeInterval	ARCCore	EnumMember	Specifies a certain time interval for which the property's value shall be sent over the -PropertyStream-.
ARCCore.PKRelAttributeP	ARCCore	Enum	Describes class -PKRelAttribute-.
ARCCore.PKRelAttributeP.ForeignEntity	ARCCore	EnumMember	The type of foreign entity that this property points to.
ARCCore.PKRelAttributeP.OppositeTerm	ARCCore	EnumMember	Example: For 'Employee', the key 'SupervisorId' where the supervisor is another 'Employee', will have another meaning "as seen from" the Supervisor, namely "Subordinates" or similar.
ARCCore.PKRelAttributeP.EnforceReferentialIntegrity	ARCCore	EnumMember	If TRUE then referential integrity will be enforced by -TryStore-.
ARCCore.PKTypeAttributeP	ARCCore	Enum	Describes class -PKTypeAttribute-.
ARCCore.ActualConnectionP	ARCCore	Enum	Describes class -ActualConnection-.
ARCCore.ActualConnectionP.Id	ARCCore	EnumMember	When connection is used with-StreamProcessor-, the Id should be the same as the key used in the incoming / outgoing connection dictionary collection.
ARCCore.ActualConnectionP.ConnectionInstruction	ARCCore	EnumMember	Only relevant when we are an -Outgoing-.
ARCCore.ActualConnectionP.ConnectionDirection	ARCCore	EnumMember
ARCCore.ActualConnectionP.CountReceiveMessage	ARCCore	EnumMember
ARCCore.ActualConnectionP.CountSendMessage	ARCCore	EnumMember
ARCCore.ActualConnectionP.ClientUpdatePosition	ARCCore	EnumMember	Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCCore.ActualConnectionP.SubscriptionAsRequestedByClient	ARCCore	EnumMember	Originates from -Subscription-.
ARCCore.ActualConnectionP.ClosingReason	ARCCore	EnumMember	Reason why this connection was closed
ARCCore.ActualConnectionP.IsErrorCondition	ARCCore	EnumMember	Some kind of error condition has occured regarding data going back and forth, but the TCP/IP connection itself is probably sound.
ARCCore.ActualConnectionP.ErrorConditionData	ARCCore	EnumMember	Detailed explanation about -IsErrorCondition-
ARCCore.ActualConnectionP.UnderClosure	ARCCore	EnumMember	Set to TRUE if to be closed and reinitialized.
ARCCore.ActualConnectionP.MonkeyWrench	ARCCore	EnumMember
ARCCore.ActualConnectionP.PartnerIPAddress	ARCCore	EnumMember	TODO: Use more strongly typing for this.
ARCCore.ConnectionInstructionP	ARCCore	Enum	Describes class -ConnectionInstruction-.
ARCCore.ConnectionInstructionP.ClientId	ARCCore	EnumMember	The AgoRapide node-id for which this connection is relevant. Used for distributing over the -PropertyStream- information to the clients about which possible nodes they can connect to.
ARCCore.StreamProcessorP.ClientUpdatePosition	ARCCore	EnumMember	Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCCore.StreamProcessorP.IncomingConnectionsPortNo	ARCCore	EnumMember	If not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-).
ARCCore.StreamProcessorP.UnderClosure	ARCCore	EnumMember	Set to TRUE if to be closed, whenever an exception occurs or when class goes out of scope
ARCCore.StreamProcessorP.WriteToConsole	ARCCore	EnumMember	If true then incoming data (from other nodes will be written to console.
ARCCore.StreamProcessorP.Timestamp	ARCCore	EnumMember	The timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-.
ARCCore.StreamProcessorP.TimestampIsOld	ARCCore	EnumMember	A warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date.
ARCCore.StreamProcessorP.TimestampResolution	ARCCore	EnumMember	The time interval between each timestamp update in the -PropertyStream-.
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-.
ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocally	ARCCore	EnumMember	Means 'do not store local origin locally but wait until it gets confirmed by core storage'.
ARCCore.StreamProcessorP.CacheDiskWrites	ARCCore	EnumMember	If TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance.
ARCCore.StreamProcessorP.CopyFileStructureFromCore	ARCCore	EnumMember	If TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-).
ARCCore.StreamProcessorP.CountIncomingConnections	ARCCore	EnumMember
ARCCore.StreamProcessorP.CountOutgoingConnections	ARCCore	EnumMember
ARCCore.StreamProcessorP.CountOutsideLocalReceiver	ARCCore	EnumMember	Count of calls to -OutsideLocalReceiver-.
ARCCore.StreamProcessorP.CountReceiveLocalOrigin	ARCCore	EnumMember	Count of -PropertyStreamLine- with -HasLocalOrigin-.
ARCCore.StreamProcessorP.CountReceiveNonLocalOrigin	ARCCore	EnumMember	Count of -PropertyStreamLine- not with -HasLocalOrigin-.
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.SetPVDirect	ARCDoc	ClassMember	High performance alternative to -TrySetP-, accessing -Storage- more direct.
ARCDoc.Orange.GetPVDirect	ARCDoc	ClassMember	High performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCDoc.Orange.TryGetPVDirect	ARCDoc	ClassMember	High performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCDoc.Orange.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
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.
ARCDoc.DocFrag.ToHTMLSimpleSingle	ARCDoc	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.DocFrag.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.

Generated 2026-06-28 10:34:41.162 UTC