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

124 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
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
ARCQuery.ValueComparerDateTime.TryParse	ARCQuery	ClassMember	Note: This parser is probably exhaustive but not necessarily logical
ARCQuery.ValueComparerDateTime.Resolution	ARCQuery	ClassMember	See -ResolutionEnum-.
ARCQuery.ValueComparerDateTime.Steps	ARCQuery	ClassMember	Value 0 would mean 'This', like ThisHour, Today, ThisMonth and so on.
ARCQuery.ValueComparerDateTime.IsGliding	ARCQuery	ClassMember	The modifier 'Gliding' (or just 'G') can be appended in order to mean continous gliding periode, so for instance
ARCQuery.ValueComparerDateTime.IsBefore	ARCQuery	ClassMember	The modifier 'Before' can be prepended in order to mean from any time before the specified time.
ARCQuery.ValueComparerDateTime.IsAfter	ARCQuery	ClassMember	The modifier 'After' can be prepended in order to mean any time after the specified time.
ARCQuery.ValueComparerDateTime.IsInterval	ARCQuery	ClassMember	Normally the interval which is compared against is the timespan corresponding to -Resolution-.
ARCQuery.ValueComparerDateTime.InitValue	ARCQuery	ClassMember	For debugging purposes. The initial 'now' value used before calculating -StartPeriod- and -EndPeriod-.
ARCQuery.ValueComparerDateTime.StartPeriod	ARCQuery	ClassMember	The start of the interval which this instance compares against.
ARCQuery.ValueComparerDateTime.EndPeriod	ARCQuery	ClassMember	The end of the interval which this instance compares against.
ARCQuery.ValueComparerDateTime.ToDebugProperties	ARCQuery	ClassMember	Exposes all members of this class.
ARCQuery.ForeignKey+IKIPEqualityComparer	ARCQuery	Class	Used by -TryGetPInternal- when it needs distinct list of foreign entities, based on their keys
ARCQuery.ForeignKey+EntityTypeAndKey	ARCQuery	Class	Describes an entity type and a key.
ARCQuery.ForeignKey+EntityTypeAndKey.EntityType	ARCQuery	ClassMember	For -IPRelationsKeysPointingTo-, corresponds to foreign entity type.
ARCQuery.ForeignKey+EntityTypeAndKey.Key	ARCQuery	ClassMember	NOTE: Key in EntityTypeAndKey was relaxed from PK to IK 25 Feb 2022 in order for experiment in -ForeignKey- to work.
ARCQuery.ForeignKey+EntityTypeAndKey.OppositeTerm	ARCQuery	ClassMember	Corresponds to -PKRelAttributeP-.- OppositeTerm-.
ARCQuery.ForeignKey+ForeignKeySingleStep	ARCQuery	Class	Describes how to traverse between related entities.
ARCQuery.ForeignKey+ForeignKeySingleStep.ForeignEntitiesCollection	ARCQuery	ClassMember	The collection containing all the (foreign) entities for the type that this step leads to
ARCQuery.QueryExpressionSelfCreate+ISelfCreateCollection	ARCQuery	Class	Provides a standardized mechanism for describing classes that are able to autogenerate collection of themeselves.
ARCQuery.ForeignKeyDirection	ARCQuery	Enum	Describes the type of traversing to a foreign entity possible.
ARCQuery.ForeignKeyDirection.ToOne	ARCQuery	EnumMember	Traverse to one entity, like traversing from OrderLine to Order (based on OrderLine containing foreign key OrderId) or Order to Customer (based on Order containing foreign key CustomerId).
ARCQuery.ForeignKeyDirection.ToMany	ARCQuery	EnumMember	Traverse to many entities, like traversing from Customer to Order (based on Order containing foreign key CustomerId) or Order to OrderLine (based on OrderLine containing foreign key OrderId).
ARCQuery.AggregationType	ARCQuery	Enum	Used by -QueryExpressionPivot- and -QueryExpressionAggregate-.
ARCQuery.AggregationType.Count	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.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-.
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
ARCCore.IKDate.ValidDateTimeFormats	ARCCore	ClassMember	Note: Be very careful about expanding this array. ToString must be considered, and also how Equals should work with other sub classes of IK.
ARCCore.IKLong	ARCCore	Class	A more memory efficient alternative to -IKString-.
ARCCore.IKLong.op_Equality	ARCCore	ClassMember	It is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here.
ARCCore.IKLong.EnrichKey	ARCCore	ClassMember	'Implementing' -ITypeDescriber-.
ARCCore.IKString	ARCCore	Class	Index key for any general id, like primary-key or sequence-number or similar.
ARCCore.IKString.FromCache	ARCCore	ClassMember	Reduces number of objects generated by caching those known to be within a limited range
ARCCore.IKString.FromString	ARCCore	ClassMember	Note how uses instance cache if already exists there
ARCCore.IKString.op_Equality	ARCCore	ClassMember	It is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here.
ARCCore.IKString.EnrichKey	ARCCore	ClassMember	'Implementing' -ITypeDescriber-.
ARCCore.IKType	ARCCore	Class	Index key used when storing a collection of a given type, like 'Customer'.
ARCCore.IKType.ToString	ARCCore	ClassMember	Caching is supposed to be useful because may be called quite often.
ARCCore.ITypeDescriber	ARCCore	Class	Provides a standardized mechanism for describing single-property values (like 'PhoneNumber' of 'Customer' for instance).
ARCCore.ITypeDescriber.GetSyntaxHelp	ARCCore	ClassMember	Enables explanation of syntax in different contexts from one source:
ARCCore.ParseResult	ARCCore	Class	NOTE: Concept is very old, from the dark ages of AgoRapide's very first inception. There might be room for improvement.
ARCCore.ParseResult.Result	ARCCore	ClassMember	Will be null if ErrorResponse is set.
ARCCore.ParseResult.ErrorResponse	ARCCore	ClassMember	Will be null if Result is set
ARCCore.PK	ARCCore	Class	PK = AgoRapide PropertyKey.
ARCCore.PK.TryGetEnum	ARCCore	ClassMember	Note that usually you will not have to ask for this value, usually in AgoRapide it goes the other way around, you have the enum member / enum value and want the corresponding property key.
ARCCore.PK.TryGetV	ARCCore	ClassMember	Only type of PK, string or type of __enum is allowed to ask for (as TRequest generic type parameter).
ARCCore.PK.GetA	ARCCore	ClassMember	Convenience method for easy access to -BasePKAttribute- with corresponding explaining exception if fails
ARCCore.PK.TryGetA	ARCCore	ClassMember	Convenience method for easy access to -BasePKAttribute-.
ARCCore.PK.ModifyCleanerAndValidatorAndParserForCardinality	ARCCore	ClassMember	Called from -Initialize- after _cleaner and _validatorAndParser have been set.
ARCCore.PK.ToString	ARCCore	ClassMember	Caching is supposed to be useful because may be called quite often.
ARCCore.PK.TryValidateAndParse	ARCCore	ClassMember	Parses the value according to specifications for this property key.
ARCCore.PK.TryCleanValidateAndParse	ARCCore	ClassMember	Cleans and parses the value according to specifications for this property key.
ARCCore.PK.PackParseResultForStorageInEntityObject	ARCCore	ClassMember	Packs result of parsing into a -IP--derived class, suitable for sending to -AddOrUpdateP-.
ARCCore.PK.PackObjectForStorageInEntityObject	ARCCore	ClassMember	See -PackParseResultForStorageInEntityObject- for documentation.
ARCCore.PK.FromEnum	ARCCore	ClassMember	Returns the corresponding -PK- instance from the given -PropertyKeyEnum-.
ARCCore.PK.TryGetFromTypeAndFieldName Overload3	ARCCore	ClassMember	Returns property key based on type and field name.
ARCCore.PK.TryGetFromTypeAndFieldName Overload2	ARCCore	ClassMember	Returns property key based on type and field name.
ARCCore.PK.TryGetFromTypeAndFieldName Overload1	ARCCore	ClassMember	Returns property key based on type and field name.
ARCCore.PK.GetAllPKForEntityType	ARCCore	ClassMember	Returns all property keys relevant for the given entity type,
ARCCore.PK.GetAllPKForEntityTypeString	ARCCore	ClassMember	Returns all property keys relevant for the given entity type,
ARCCore.PK.BuildFromStringCache	ARCCore	ClassMember	Builds the content of -_fromStringCache- and also -_allPKForEntityTypeCache-.
ARCCore.PK.GetTypeMapping	ARCCore	ClassMember	Returns the relevant property key for a given type entity-type and field-type.
ARCCore.PK.GetObligatoryValuesForEntityType	ARCCore	ClassMember	Returns all obligatory values (based on -IsObligatory-)
ARCCore.PK.Equals	ARCCore	ClassMember	Note that ToString is only based on __enum, meaning that two enum members / enum values with same name but different type, like CustomerP.Name and OrderP.Name, will be considered equal.
ARCCore.PK.TryGetP	ARCCore	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.

Generated 2025-07-12 02:50:23.508 UTC