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

128 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCAPI.ContentResult.CreateHTMLOKARCAPIClassMemberNOTE: Parameter must be a complete HTML page.
ARCAPI.ContentResult.CreateErrorARCAPIClassMemberTODO: Add a key / value format for error messages, like done for -Log-.
ARCAPI.AddControllerARCAPIClassParses and stores a -PropertyStreamLine-.
ARCAPI.AddController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCCore.PK.BuildFromStringCacheARCCoreClassMemberBuilds the content of -_fromStringCache- and also -_allPKForEntityTypeCache-.
ARCQuery.QueryExpressionTake.SyntaxHelpARCQueryClassMemberTAKE {Count}
ARCCore.ActualConnection.SetSinglePropertyStreamReceiverARCCoreClassMemberSet by -StreamProcessor-.
ARCQuery.QueryExpressionWhereARCQueryClassExecutes a 'WHERE {key} {operator} {value}' against the given collection.
ARCCore.ActualConnection.SetUpToDatePositionGeneratorARCCoreClassMemberSet by -StreamProcessor-. Not used by -Client-.
ARCQuery.QueryExpressionWhere.ExecuteARCQueryClassMemberTransforms the given input collection into a resulting collection.
ARCCore.ActualConnection.InitializeOutgoingConnectionARCCoreClassMemberRelevant for -Outgoing-.
ARCQuery.QueryExpressionWhere.IsMatchARCQueryClassMemberReturns TRUE if property matches criteria.
ARCCore.ActualConnection.CommunicateARCCoreClassMemberCommon for both -Incoming- and -Outgoing-.
ARCQuery.QueryExpressionWhere.TryCheckForExistenceOfKeyARCQueryClassMemberUsed by query expressions in order to catch wrong field names used or misspelling of field names.
ARCCore.ActualConnection.LogAndSendErrorConditionDataARCCoreClassMemberCalled when a serious error condition has been discovered and connection should be terminated.
ARCQuery.QueryExpressionWhere.SyntaxHelpARCQueryClassMemberWHERE {key} {operator} {value}
ARCCore.ActualConnection.SendARCCoreClassMemberSends all messages in queue.
ARCQuery.QueryExpressionWhere.ValueARCQueryClassMemberThe 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.ActualConnection.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryProgressARCQueryClassKeeps track of execution of query (that is, a query consisting of multiple -QueryExpression-), and also stores final result.
ARCCore.ActualConnectionP.IdARCCoreEnumMemberWhen connection is used with-StreamProcessor-, the Id should be the same as the key used in the incoming / outgoing connection dictionary collection.
ARCQuery.QueryProgress.ToJSONSerializeableARCQueryClassMemberOverride of default interface method -ToJSONSerializeable- is necessary because resulting data is 'hidden' within -Result-.
ARCCore.ActualConnectionP.ConnectionInstructionARCCoreEnumMemberOnly relevant when we are an -Outgoing-.
ARCQuery.QueryProgress.PreviousQueryJustExecutedARCQueryClassMemberTODO: This is somewhat loosely associated.
ARCCore.ActualConnectionP.ConnectionDirectionARCCoreEnumMember 
ARCQuery.QueryProgress.NextQueryToExecuteARCQueryClassMemberTODO: This is somewhat loosely associated.
ARCCore.ActualConnectionP.CountReceiveMessageARCCoreEnumMember 
ARCQuery.QueryProgress.ToHTMLSimpleSingleARCQueryClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCCore.ActualConnectionP.CountSendMessageARCCoreEnumMember 
ARCQuery.QueryProgress.OrderAndReconstructKeysARCQueryClassMemberPart 1:
ARCCore.ActualConnectionP.ClientUpdatePositionARCCoreEnumMemberNote how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCQuery.QueryProgress.GetHTMLLinksToIndividualQueryPartsARCQueryClassMemberIs able to generate the following:
ARCCore.ActualConnectionP.SubscriptionAsRequestedByClientARCCoreEnumMemberOriginates from -Subscription-.
ARCQuery.QueryProgress.ToStringARCQueryClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.ActualConnectionP.ClosingReasonARCCoreEnumMemberReason why this connection was closed
ARCQuery.QueryProgress.ResultARCQueryClassMemberThis gets updated continously as the different query expressions get evaluated.
ARCCore.ActualConnectionP.IsErrorConditionARCCoreEnumMemberSome kind of error condition has occured regarding data going back and forth, but the TCP/IP connection itself is probably sound.
ARCQuery.QueryProgress.ExecutedQueriesARCQueryClassMemberThe result from calling -Execute- for each query in -Queries-.
ARCCore.ActualConnectionP.ErrorConditionDataARCCoreEnumMemberDetailed explanation about -IsErrorCondition-
ARCQuery.QueryProgress.AdditionalJavascriptUrlEncoderARCQueryClassMemberReturns the Javascript code for converting characters that are difficult to pass in URLs to a format understood by -Decode-.
ARCCore.ActualConnectionP.UnderClosureARCCoreEnumMemberSet to TRUE if to be closed and reinitialized.
ARCQuery.UtilQueryARCQueryClassUtility methods for -ARCQuery-.
ARCCore.ActualConnectionP.MonkeyWrenchARCCoreEnumMember 
ARCQuery.UtilQuery.IndexOfOutsideOfARCQueryClassMemberEquivalent to string.IndexOf except that any character encountered inside pairs of the 'outsideOf'-char are not counted.
ARCCore.ActualConnectionP.PartnerIPAddressARCCoreEnumMemberTODO: Use more strongly typing for this.
ARCQuery.UtilQuery.IndexOfAnyOutsideOfARCQueryClassMemberEquivalent to string.IndexOfAny except that any character encountered inside pairs of the 'outsideOf'-char are not counted.
ARCCore.ConnectionInstructionPARCCoreEnumDescribes class -ConnectionInstruction-.
ARCQuery.UtilQuery.SplitOutsideOfARCQueryClassMemberEquivalent to string.Split except that any character encountered inside pairs of the 'outsideOf'-char are not counted as separators.
ARCCore.ConnectionInstructionP.ClientIdARCCoreEnumMemberThe 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.
ARCQuery.UtilQuery.SpecialLinkPrefixesARCQueryClassMemberContains prefixes for which links (see -LinkInsertionInDocumentation-) are also desired without the prefix.
ARCCore.ConnectionInstructionP.ServerHostNameARCCoreEnumMemberThe host (DNS or IP-address) for which to connect.
ARCQuery.ValueComparerARCQueryClassCan evaluation expressions like 'WHERE Created = ThisYear.
ARCCore.ConnectionInstructionP.ServerPortNoARCCoreEnumMemberThe port number for which to connect.
AgoMail.EmailP.TextBodyAgoMailEnumMember 
ARCCore.ConnectionInstructionP.ConnectionIdARCCoreEnumMemberUsually a combination of -ClientId-, -ServerHostName- and -ServerPortNo-.
AgoMail.EmailP.HTMLBodyAgoMailEnumMember 
ARCCore.ConnectionInstructionP.DataTransferDirectionARCCoreEnumMember 
AgoMail.EmailP.HeadersAgoMailEnumMember 
ARCCore.ConnectionInstructionP.SubscriptionARCCoreEnumMemberThe actual subscripton. This is what the connecting party / (downstream) client would send over its TCP/IP connection to the (upstream) server.
AgoMail.EmailP.AttachmentsAgoMailEnumMember 
ARCQuery.NewKeyCountPRec.CountPRecARCQueryClassMemberCounts recursively the number of properties for a given entity object.
Namespace ARCCore NamespaceA necessary library (.DLL in Windows terms) that every -ARNodeType- should link to.
ARCQuery.NewKeyCountPRec.ToStringARCQueryClassMemberThe ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
Namespace ARCDoc NamespaceA library supporting documentation and demonstrating usage of AgoRapide.
ARCQuery.NewKeyCountPRec.TryGetPARCQueryClassMemberThe outwards facing executor, understanding use of -FunctionKeys-.
Namespace ARCQuery NamespaceARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
ARCQuery.NewKeyCountPRec.SyntaxHelpARCQueryClassMember'CountPRec()'
Namespace ARCAPI NamespaceA library providing an API on top of the -PropertyStream-.
ARCQuery.NewKeyCountPRec.FunctionKeysARCQueryClassMemberAll -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
Namespace AgoMail Namespace 
ARCQuery.NewKeyCountPRec.QuantileKeyARCQueryClassMemberEventual final -QuantileKey- at end of compound key.
Namespace AgoMail.Controllers Namespace 
ARCQuery.NewKeyGetTypeARCQueryClassReturns the internal C# object type of the given object.
ARCQuery.NewKeyGetType.TryGetPInternalARCQueryClassMemberThe internal executor, containing the specific functionality for how to evaluate the key.
ARCQuery.NewKeyGetType.ToStringARCQueryClassMemberThe ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCQuery.NewKeyGetType.TryGetPARCQueryClassMemberThe outwards facing executor, understanding use of -FunctionKeys-.
ARCQuery.NewKeyGetType.SyntaxHelpARCQueryClassMember'GetType()'
ARCQuery.NewKeyGetType.FunctionKeysARCQueryClassMemberAll -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCQuery.ValueComparer.TryGetPreviousARCQueryClassMemberSuggestion for previous query (browsing 'backwards')
ARCQuery.ValueComparer.TryGetNextARCQueryClassMemberSuggestion for next query (browsing 'forwards')
ARCQuery.ValueComparerDateTimeARCQueryClass-ValueComparerDateTime- is an attempt at offering a human language interface for date and time queries.
ARCQuery.ValueComparerDateTime.TryGetPreviousARCQueryClassMemberSuggestion for previous query (browsing 'backwards')
ARCQuery.ValueComparerDateTime.TryGetNextARCQueryClassMemberSuggestion for next query (browsing 'forwards')
ARCQuery.ValueComparerDateTime.TryParseARCQueryClassMemberNote: This parser is probably exhaustive but not necessarily logical
ARCQuery.ValueComparerDateTime.ResolutionARCQueryClassMemberSee -ResolutionEnum-.
ARCQuery.ValueComparerDateTime.StepsARCQueryClassMemberValue 0 would mean 'This', like ThisHour, Today, ThisMonth and so on.
ARCQuery.ValueComparerDateTime.IsGlidingARCQueryClassMemberThe modifier 'Gliding' (or just 'G') can be appended in order to mean continous gliding periode, so for instance
ARCQuery.ValueComparerDateTime.IsBeforeARCQueryClassMemberThe modifier 'Before' can be prepended in order to mean from any time before the specified time.
ARCQuery.ValueComparerDateTime.IsAfterARCQueryClassMemberThe modifier 'After' can be prepended in order to mean any time after the specified time.
ARCQuery.ValueComparerDateTime.IsIntervalARCQueryClassMemberNormally the interval which is compared against is the timespan corresponding to -Resolution-.
ARCQuery.Quantile.MEDIANARCQueryEnumMemberDivide into two parts
ARCQuery.Quantile.TERTILEARCQueryEnumMemberDivide into three parts
ARCQuery.Quantile.QUARTILEARCQueryEnumMemberDivide into four parts
ARCQuery.Quantile.QUINTILEARCQueryEnumMemberDivide into five parts
ARCAPI.AddController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.Quantile.PERMILLEARCQueryEnumMemberDivide into 1000 parts
ARCAPI.AddController.AllowFilterARCAPIClassMemberDescribes what data is allowed to change through a list of -Subscription- instances.
ARCQuery.QueryProgressPARCQueryEnumDescribes class -QueryProgress-.
ARCAPI.BaseControllerARCAPIClassContains basic functionality for serving API methods.
ARCQuery.QueryProgressP.QueriesARCQueryEnumMember 
ARCAPI.BaseController.BuildControllerStorageARCAPIClassMemberBuilds a collection of 'std' (standard) controller instances to use for serving API requests.
ARCQuery.QueryProgressP.StrCurrentTypeARCQueryEnumMemberNormally the -ToStringVeryShort- representation of the type of objects in the -Result- collection.
ARCAPI.BaseController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCQuery.QueryProgressP.CurrentStrictnessARCQueryEnumMemberDescribes -Strictness- ON / OFF when executing query.
ARCAPI.BaseController.CatchAllARCAPIClassMemberServes the typical single generic API method in an AgoRapide API.
ARCQuery.QueryProgressP.CreateHintsARCQueryEnumMemberDescribes if hints are to be generated (as query progresses) for new queries.
ARCAPI.BaseController.TryNavigateToLevelInDataStorageARCAPIClassMemberNavigates to the specified level (usually within -Storage-).
ARCQuery.QueryProgressP.UseCacheARCQueryEnumMemberDescribes if cache is to be used or not.
ARCAPI.BaseController.GetFormatAndAdjustRequestARCAPIClassMemberDecides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).
ARCQuery.QueryProgressP.LimitARCQueryEnumMemberLimits 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.GetTimestampIsOldWarningHTMLARCAPIClassMemberIf -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format.
ARCQuery.QueryProgressP.TerminateReasonARCQueryEnumMemberThe reason for a query being terminated. This property should contain a user friendly message about the problem and how to fix it.
ARCAPI.BaseController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryProgressP.AllLogEntriesForThisQueryARCQueryEnumMember 
ARCAPI.EditControllerARCAPIClassOffers a simple HTML editing environment of the raw -PropertyStream- from the given key.
ARCQuery.EntityMethodKey+MethodTypeARCQueryEnumExplains type of method signature found (trough reflection) for corresponding entity class.
ARCAPI.EditController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCQuery.EntityMethodKey+MethodType.SimpleARCQueryEnumMemberSignature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)'
ARCAPI.EditController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.EntityMethodKey+MethodType.ComplexARCQueryEnumMemberSignature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)'
ARCAPI.GQControllerARCAPIClassOffers GraphQL queries.
ARCQuery.QueryExpressionWhere+ValueEnumARCQueryEnumHelper enum used internally by -QueryExpressionWhere- in order to represent queries like WHERE Name = NULL, WHERE Name = NOTNULL and WHERE Name = * (ALL).
ARCAPI.GQController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCQuery.QueryExpressionWhere+ValueEnum.NULLARCQueryEnumMember 
ARCAPI.GQController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULLARCQueryEnumMemberPractical value enabling suggestions from -GetPrevious- and -GetNext-.
ARCAPI.RQControllerARCAPIClassRQ = REST Query. Executes a REST like query request against the given -DataStorage-.
ARCQuery.QueryExpressionWhere+ValueEnum.ALLARCQueryEnumMemberEquivalent to query like WHERE Name = *

Generated 2026-11-04 22:41:12.089 UTC