[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() SKIP 902

165 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCAPI.AddController.AllowFilter	ARCAPI	ClassMember	Describes what data is allowed to change through a list of -Subscription- instances.
ARCQuery.FunctionKeyHourMinute.SyntaxHelp	ARCQuery	ClassMember	'HourMinute()'
ARCQuery.Quantile.SEPTILE	ARCQuery	EnumMember	Divide into 7 parts
ARCQuery.NewKeyToPropertyStream.TryGetPInternal	ARCQuery	ClassMember	The internal executor, containing the specific functionality for how to evaluate the key.
ARCAPI.BaseController	ARCAPI	Class	Contains basic functionality for serving API methods.
ARCQuery.FunctionKeyInt	ARCQuery	Class	Rounds a double value to the nearest integer (uses .NET data type Int64 (long)).
ARCQuery.Quantile.OCTILE	ARCQuery	EnumMember	Divide into 8 parts
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}'.
ARCAPI.BaseController.BuildControllerStorage	ARCAPI	ClassMember	Builds a collection of 'std' (standard) controller instances to use for serving API requests.
ARCQuery.FunctionKeyInt.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.Quantile.DECILE	ARCQuery	EnumMember	Divide into 10 parts
ARCQuery.NewKeyToPropertyStream.TryGetP	ARCQuery	ClassMember	The outwards facing executor, understanding use of -FunctionKeys-.
ARCAPI.BaseController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCQuery.FunctionKeyInt.SyntaxHelp	ARCQuery	ClassMember	'Int()'
ARCQuery.Quantile.DUODECILE	ARCQuery	EnumMember	Divide into 12 parts
ARCQuery.NewKeyToPropertyStream.SyntaxHelp	ARCQuery	ClassMember	'ToPropertyStream()'
ARCAPI.BaseController.CatchAll	ARCAPI	ClassMember	Serves the typical single generic API method in an AgoRapide API.
ARCQuery.FunctionKeyLength	ARCQuery	Class	Returns length of (string) value of field, like 4 for 'John'.
ARCQuery.Quantile.HEXADECILE	ARCQuery	EnumMember	Divide into 16 parts
ARCQuery.NewKeyToPropertyStream.FunctionKeys	ARCQuery	ClassMember	All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCAPI.BaseController.TryNavigateToLevelInDataStorage	ARCAPI	ClassMember	Navigates to the specified level (usually within -Storage-).
ARCQuery.FunctionKeyLength.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.Quantile.VENTILE	ARCQuery	EnumMember	Divide into 20 parts
ARCQuery.NewKeyToPropertyStream.QuantileKey	ARCQuery	ClassMember	Eventual final -QuantileKey- at end of compound key.
ARCAPI.BaseController.GetFormatAndAdjustRequest	ARCAPI	ClassMember	Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).
ARCQuery.FunctionKeyLength.SyntaxHelp	ARCQuery	ClassMember	'Length()'
ARCQuery.Quantile.PERCENTILE	ARCQuery	EnumMember	Divide into 100 parts
ARCQuery.QueryExpressionTake.SyntaxHelp	ARCQuery	ClassMember	TAKE {Count}
AgoMail.EmailP.TextBody	AgoMail	EnumMember
ARCQuery.FunctionKeyType.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.QueryExpressionWhere	ARCQuery	Class	Executes a 'WHERE {key} {operator} {value}' against the given collection.
AgoMail.EmailP.HTMLBody	AgoMail	EnumMember
ARCQuery.FunctionKeyType.SyntaxHelp	ARCQuery	ClassMember	'Type()'
ARCQuery.QueryExpressionWhere.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
AgoMail.EmailP.Headers	AgoMail	EnumMember
ARCQuery.FunctionKeyWeek	ARCQuery	Class	Extract week-number from field according to ISO 8601.
ARCQuery.QueryExpressionWhere.IsMatch	ARCQuery	ClassMember	Returns TRUE if property matches criteria.
AgoMail.EmailP.Attachments	AgoMail	EnumMember
ARCQuery.FunctionKeyWeek.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.QueryExpressionWhere.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
Namespace ARCCore		Namespace	A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to.
ARCQuery.FunctionKeyWeek.SyntaxHelp	ARCQuery	ClassMember	'Week()'
ARCQuery.QueryExpressionWhere.SyntaxHelp	ARCQuery	ClassMember	WHERE {key} {operator} {value}
Namespace ARCDoc		Namespace	A library supporting documentation and demonstrating usage of AgoRapide.
ARCQuery.FunctionKeyYear	ARCQuery	Class	Extracts Year-component from field.
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.
Namespace ARCQuery		Namespace	ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
ARCQuery.FunctionKeyYear.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.QueryProgress	ARCQuery	Class	Keeps track of execution of query (that is, a query consisting of multiple -QueryExpression-), and also stores final result.
Namespace ARCAPI		Namespace	A library providing an API on top of the -PropertyStream-.
ARCQuery.FunctionKeyYear.SyntaxHelp	ARCQuery	ClassMember	'Year()'
ARCQuery.QueryProgress.ToJSONSerializeable	ARCQuery	ClassMember	Override of default interface method -ToJSONSerializeable- is necessary because resulting data is 'hidden' within -Result-.
Namespace AgoMail		Namespace
ARCQuery.QueryExpressionOrderBy.Key	ARCQuery	ClassMember	TODO: Expand syntax to include multiple keys
ARCQuery.QueryProgress.PreviousQueryJustExecuted	ARCQuery	ClassMember	TODO: This is somewhat loosely associated.
Namespace AgoMail.Controllers		Namespace
ARCQuery.QueryExpressionPivot	ARCQuery	Class	Creates a table by querying over two keys like
ARCQuery.QueryProgress.NextQueryToExecute	ARCQuery	ClassMember	TODO: This is somewhat loosely associated.
ARCQuery.QueryExpressionPivot.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryProgress.ToHTMLSimpleSingle	ARCQuery	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCQuery.QueryExpressionPivot.GetCrossSummationChecker	ARCQuery	ClassMember	Returns a cross sum checker for int, long, double, Timespan.
ARCQuery.QueryProgress.OrderAndReconstructKeys	ARCQuery	ClassMember	Part 1:
ARCQuery.QueryExpressionPivot.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryProgress.GetHTMLLinksToIndividualQueryParts	ARCQuery	ClassMember	Is able to generate the following:
ARCQuery.QueryExpressionPivot.SyntaxHelp	ARCQuery	ClassMember	1) 'PIVOT {rowKey} BY {columnKey}' like "PIVOT Colour BY Production.Year"
ARCQuery.QueryProgress.ToString	ARCQuery	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryExpressionPivot.AggregationType	ARCQuery	ClassMember	Most common value is -Count-, in which case -AggregationKey- may be correspondingly set to null.
ARCQuery.QueryProgress.Result	ARCQuery	ClassMember	This gets updated continously as the different query expressions get evaluated.
ARCQuery.QueryExpressionPivot.AggregationKey	ARCQuery	ClassMember	This is often null (with -AggregationType- correspondingly set to Count-).
ARCQuery.QueryProgress.ExecutedQueries	ARCQuery	ClassMember	The result from calling -Execute- for each query in -Queries-.
ARCQuery.QueryExpressionSkip.SyntaxHelp	ARCQuery	ClassMember	SKIP {Count} like 'SKIP 42'
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-.
ARCQuery.QueryExpressionStrict	ARCQuery	Class	Describes -Strictness- ON / OFF when executing query.
ARCQuery.UtilQuery	ARCQuery	Class	Utility methods for -ARCQuery-.
ARCQuery.QueryExpressionStrict.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.UtilQuery.IndexOfOutsideOf	ARCQuery	ClassMember	Equivalent to string.IndexOf except that any character encountered inside pairs of the 'outsideOf'-char are not counted.
ARCQuery.QueryExpressionStrict.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.UtilQuery.IndexOfAnyOutsideOf	ARCQuery	ClassMember	Equivalent to string.IndexOfAny except that any character encountered inside pairs of the 'outsideOf'-char are not counted.
ARCQuery.QueryExpressionStrict.SyntaxHelp	ARCQuery	ClassMember	STRICT {strictnessLevel}
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.
ARCQuery.QueryExpressionTake	ARCQuery	Class	Takes a specific number of elements from the current query result.
ARCQuery.UtilQuery.SpecialLinkPrefixes	ARCQuery	ClassMember	Contains prefixes for which links (see -LinkInsertionInDocumentation-) are also desired without the prefix.
ARCQuery.QueryExpressionTake.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.ValueComparer	ARCQuery	Class	Can evaluation expressions like 'WHERE Created = ThisYear.
ARCQuery.QueryExpressionTake.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.ValueComparer.TryGetPrevious	ARCQuery	ClassMember	Suggestion for previous query (browsing 'backwards')
ARCQuery.Quantile.PERMILLE	ARCQuery	EnumMember	Divide into 1000 parts
ARCQuery.ValueComparer.TryGetNext	ARCQuery	ClassMember	Suggestion for next query (browsing 'forwards')
ARCQuery.QueryProgressP	ARCQuery	Enum	Describes class -QueryProgress-.
ARCQuery.ValueComparerDateTime	ARCQuery	Class	-ValueComparerDateTime- is an attempt at offering a human language interface for date and time queries.
ARCQuery.QueryProgressP.Queries	ARCQuery	EnumMember
ARCQuery.ValueComparerDateTime.TryGetPrevious	ARCQuery	ClassMember	Suggestion for previous query (browsing 'backwards')
ARCQuery.QueryProgressP.StrCurrentType	ARCQuery	EnumMember	Normally the -ToStringVeryShort- representation of the type of objects in the -Result- collection.
ARCQuery.ValueComparerDateTime.TryGetNext	ARCQuery	ClassMember	Suggestion for next query (browsing 'forwards')
ARCQuery.QueryProgressP.CurrentStrictness	ARCQuery	EnumMember	Describes -Strictness- ON / OFF when executing query.
ARCQuery.ValueComparerDateTime.TryParse	ARCQuery	ClassMember	Note: This parser is probably exhaustive but not necessarily logical
ARCQuery.QueryProgressP.CreateHints	ARCQuery	EnumMember	Describes if hints are to be generated (as query progresses) for new queries.
ARCQuery.ValueComparerDateTime.Resolution	ARCQuery	ClassMember	See -ResolutionEnum-.
ARCQuery.QueryProgressP.UseCache	ARCQuery	EnumMember	Describes if cache is to be used or not.
ARCQuery.ValueComparerDateTime.Steps	ARCQuery	ClassMember	Value 0 would mean 'This', like ThisHour, Today, ThisMonth and so on.
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.DataStorage.DocLinks	ARCAPI	ClassMember	Note that may be null.
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.
ARCAPI.DataStorage.Lock	ARCAPI	ClassMember	Locking object for thread-safe access from simultaneous API requests.
ARCQuery.QueryProgressP.AllLogEntriesForThisQuery	ARCQuery	EnumMember
ARCAPI.DataStorage.ExternalReceiver	ARCAPI	ClassMember	Typically used by -AddController-.
ARCQuery.EntityMethodKey+MethodType	ARCQuery	Enum	Explains type of method signature found (trough reflection) for corresponding entity class.
ARCAPI.DataStorage.DoNotStoreInternally	ARCAPI	ClassMember	Typically used by -AddController-.
ARCQuery.EntityMethodKey+MethodType.Simple	ARCQuery	EnumMember	Signature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)'
ARCAPI.BaseControllerP	ARCAPI	Enum	Describes class -BaseController-.
ARCQuery.EntityMethodKey+MethodType.Complex	ARCQuery	EnumMember	Signature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)'
ARCAPI.BaseControllerP.CountRequest	ARCAPI	EnumMember	Number of calls to -APIMethod- since application initialization
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).
ARCAPI.BaseControllerP.CountException	ARCAPI	EnumMember	Number of exceptions at call to -APIMethod- since application initialization
ARCQuery.QueryExpressionWhere+ValueEnum.NULL	ARCQuery	EnumMember
ARCAPI.BaseControllerP.LogLevel	ARCAPI	EnumMember
ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULL	ARCQuery	EnumMember	Practical value enabling suggestions from -GetPrevious- and -GetNext-.
ARCAPI.ResponseFormat	ARCAPI	Enum	The response format, HTML or JSON, for an API request.
ARCQuery.QueryExpressionWhere+ValueEnum.ALL	ARCQuery	EnumMember	Equivalent to query like WHERE Name = *
ARCAPI.ResponseFormat.JSON	ARCAPI	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum	ARCQuery	Enum
ARCAPI.ResponseFormat.HTML	ARCAPI	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum.Second	ARCQuery	EnumMember
Assembly AgoMail		Assembly
ARCQuery.ValueComparerDateTime+ResolutionEnum.Minute	ARCQuery	EnumMember
AgoMail.Cleaner	AgoMail	Class
ARCQuery.ValueComparerDateTime+ResolutionEnum.Hour	ARCQuery	EnumMember
AgoMail.Cleaner.Clean	AgoMail	ClassMember	Removes emails with often seen values for Subject, To or From.
ARCQuery.ValueComparerDateTime+ResolutionEnum.Day	ARCQuery	EnumMember
AgoMail.Email	AgoMail	Class
ARCQuery.ValueComparerDateTime+ResolutionEnum.Week	ARCQuery	EnumMember
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).
ARCQuery.ValueComparerDateTime+ResolutionEnum.Month	ARCQuery	EnumMember
AgoMail.Email.ToString	AgoMail	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCAPI.BaseController.GetTimestampIsOldWarningHTML	ARCAPI	ClassMember	If -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format.
AgoMail.Program	AgoMail	Class	Application startup and initialization
ARCAPI.BaseController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
AgoMail.Program.InitStreamProcessor	AgoMail	ClassMember	Initializes stream processor.
ARCAPI.EditController	ARCAPI	Class	Offers a simple HTML editing environment of the raw -PropertyStream- from the given key.
AgoMail.Root	AgoMail	Class	Contains the user friendly welcome text (front page) for the application.
ARCAPI.EditController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
AgoMail.Root.ToHTMLSimpleSingle	AgoMail	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCAPI.EditController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
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).
ARCAPI.GQController	ARCAPI	Class	Offers GraphQL queries.
AgoMail.Root.ToString	AgoMail	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCAPI.GQController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
AgoMail.Controllers.ControllerFacade	AgoMail	Class	Facade for entry into the desired -BaseController-.
ARCAPI.GQController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
AgoMail.Controllers.ControllerFacade.CatchAll Overload2	AgoMail	ClassMember	Catches all HTTP GET requests to this API.
ARCAPI.RQController	ARCAPI	Class	RQ = REST Query. Executes a REST like query request against the given -DataStorage-.
AgoMail.Controllers.ControllerFacade.CatchAll Overload1	AgoMail	ClassMember	Catches all HTTP POST requests to this API.
ARCAPI.RQController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
AgoMail.EmailP	AgoMail	Enum
ARCAPI.RQController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
AgoMail.EmailP.Date	AgoMail	EnumMember	UTC-format
ARCAPI.DataStorage	ARCAPI	Class	The all-in-memory global application data storage.
AgoMail.EmailP.From	AgoMail	EnumMember
ARCAPI.DataStorage.Create	ARCAPI	ClassMember	Creates a -DataStorage- instance with default parameters.
AgoMail.EmailP.To	AgoMail	EnumMember
ARCAPI.DataStorage..ctor	ARCAPI	ClassMember	This method will:
AgoMail.EmailP.CC	AgoMail	EnumMember
ARCAPI.DataStorage.Storage	ARCAPI	ClassMember	The actual storage.
AgoMail.EmailP.Subject	AgoMail	EnumMember
ARCAPI.DataStorage.ControllerStorage	ARCAPI	ClassMember	Usually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]).

Generated 2025-11-06 14:31:48.361 UTC