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

114 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCAPI.BaseController	ARCAPI	Class	Contains basic functionality for serving API methods.
ARCQuery.Quantile	ARCQuery	Enum	Describes quantiles like -TERTILE- and -QUARTILE-.
ARCQuery.QueryProgressP.StrCurrentType	ARCQuery	EnumMember	Normally the -ToStringVeryShort- representation of the type of objects in the -Result- collection.
ARCAPI.BaseController.BuildControllerStorage	ARCAPI	ClassMember	Builds a collection of 'std' (standard) controller instances to use for serving API requests.
ARCQuery.Quantile.MEDIAN	ARCQuery	EnumMember	Divide into two parts
ARCQuery.QueryProgressP.CurrentStrictness	ARCQuery	EnumMember	Describes -Strictness- ON / OFF when executing query.
ARCAPI.BaseController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCQuery.Quantile.TERTILE	ARCQuery	EnumMember	Divide into three parts
ARCQuery.QueryProgressP.CreateHints	ARCQuery	EnumMember	Describes if hints are to be generated (as query progresses) for new queries.
ARCAPI.BaseController.CatchAll	ARCAPI	ClassMember	Serves the typical single generic API method in an AgoRapide API.
ARCQuery.Quantile.QUARTILE	ARCQuery	EnumMember	Divide into four parts
ARCQuery.QueryProgressP.UseCache	ARCQuery	EnumMember	Describes if cache is to be used or not.
ARCAPI.BaseController.TryNavigateToLevelInDataStorage	ARCAPI	ClassMember	Navigates to the specified level (usually within -Storage-).
ARCQuery.Quantile.QUINTILE	ARCQuery	EnumMember	Divide into five parts
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.
ARCAPI.BaseController.GetFormatAndAdjustRequest	ARCAPI	ClassMember	Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).
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.TextBody	AgoMail	EnumMember
ARCQuery.QueryProgressP.AllLogEntriesForThisQuery	ARCQuery	EnumMember
AgoMail.EmailP.HTMLBody	AgoMail	EnumMember
ARCQuery.EntityMethodKey+MethodType	ARCQuery	Enum	Explains type of method signature found (trough reflection) for corresponding entity class.
AgoMail.EmailP.Headers	AgoMail	EnumMember
ARCQuery.EntityMethodKey+MethodType.Simple	ARCQuery	EnumMember	Signature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)'
AgoMail.EmailP.Attachments	AgoMail	EnumMember
ARCQuery.EntityMethodKey+MethodType.Complex	ARCQuery	EnumMember	Signature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)'
Namespace ARCCore		Namespace	A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to.
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 ARCDoc		Namespace	A library supporting documentation and demonstrating usage of AgoRapide.
ARCQuery.QueryExpressionWhere+ValueEnum.NULL	ARCQuery	EnumMember
Namespace ARCQuery		Namespace	ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULL	ARCQuery	EnumMember	Practical value enabling suggestions from -GetPrevious- and -GetNext-.
Namespace ARCAPI		Namespace	A library providing an API on top of the -PropertyStream-.
ARCQuery.QueryExpressionWhere+ValueEnum.ALL	ARCQuery	EnumMember	Equivalent to query like WHERE Name = *
Namespace AgoMail		Namespace
ARCQuery.ValueComparerDateTime+ResolutionEnum	ARCQuery	Enum
Namespace AgoMail.Controllers		Namespace
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
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
ARCQuery.QueryExpressionSkip.SyntaxHelp	ARCQuery	ClassMember	SKIP {Count} like 'SKIP 42'
ARCQuery.QueryExpressionStrict	ARCQuery	Class	Describes -Strictness- ON / OFF when executing query.
ARCQuery.QueryExpressionStrict.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionStrict.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionStrict.SyntaxHelp	ARCQuery	ClassMember	STRICT {strictnessLevel}
ARCQuery.QueryExpressionTake	ARCQuery	Class	Takes a specific number of elements from the current query result.
ARCQuery.QueryExpressionTake.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionTake.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionTake.SyntaxHelp	ARCQuery	ClassMember	TAKE {Count}
ARCQuery.QueryExpressionWhere	ARCQuery	Class	Executes a 'WHERE {key} {operator} {value}' against the given collection.
ARCQuery.QueryExpressionWhere.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionWhere.IsMatch	ARCQuery	ClassMember	Returns TRUE if property matches criteria.
ARCQuery.QueryExpressionWhere.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionWhere.SyntaxHelp	ARCQuery	ClassMember	WHERE {key} {operator} {value}
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.
ARCQuery.QueryProgress	ARCQuery	Class	Keeps track of execution of query (that is, a query consisting of multiple -QueryExpression-), and also stores final result.
ARCQuery.QueryProgress.ToJSONSerializeable	ARCQuery	ClassMember	Override of default interface method -ToJSONSerializeable- is necessary because resulting data is 'hidden' within -Result-.
ARCQuery.QueryProgress.PreviousQueryJustExecuted	ARCQuery	ClassMember	TODO: This is somewhat loosely associated.
ARCQuery.QueryProgress.NextQueryToExecute	ARCQuery	ClassMember	TODO: This is somewhat loosely associated.
ARCQuery.QueryProgress.ToHTMLSimpleSingle	ARCQuery	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCQuery.QueryProgress.OrderAndReconstructKeys	ARCQuery	ClassMember	Part 1:
ARCQuery.QueryProgress.GetHTMLLinksToIndividualQueryParts	ARCQuery	ClassMember	Is able to generate the following:
ARCQuery.QueryProgress.ToString	ARCQuery	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryProgress.Result	ARCQuery	ClassMember	This gets updated continously as the different query expressions get evaluated.
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 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).

Generated 2026-11-04 06:58:12.412 UTC