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

62 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCAPI.ContentResult.CreateHTMLOKARCAPIClassMemberNOTE: Parameter must be a complete HTML page.
ARCCore.EnumAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.ConnectionInstructionPARCCoreEnumDescribes class -ConnectionInstruction-.
ARCAPI.ContentResult.CreateErrorARCAPIClassMemberTODO: Add a key / value format for error messages, like done for -Log-.
ARCCore.EnumAttribute.IsDefaultARCCoreClassMemberDoes not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.)
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.
ARCAPI.AddControllerARCAPIClassParses and stores a -PropertyStreamLine-.
ARCCore.EnumMemberAttributeARCCoreClassDescribes an enum's value.
ARCCore.ConnectionInstructionP.ServerHostNameARCCoreEnumMemberThe host (DNS or IP-address) for which to connect.
ARCAPI.AddController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCCore.EnumMemberAttribute.GetAttributeARCCoreClassMemberNote that illegal to call for -PropertyKeyEnum-.
ARCCore.ConnectionInstructionP.ServerPortNoARCCoreEnumMemberThe port number for which to connect.
ARCAPI.AddController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.EnumMemberAttribute.InitializeARCCoreClassMemberTo be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCCore.ConnectionInstructionP.ConnectionIdARCCoreEnumMemberUsually a combination of -ClientId-, -ServerHostName- and -ServerPortNo-.
ARCAPI.AddController.AllowFilterARCAPIClassMemberDescribes what data is allowed to change through a list of -Subscription- instances.
ARCCore.EnumMemberAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.ConnectionInstructionP.DataTransferDirectionARCCoreEnumMember 
ARCAPI.BaseControllerARCAPIClassContains basic functionality for serving API methods.
ARCCore.EnumMemberAttribute.IsDefaultARCCoreClassMemberDoes not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.)
ARCCore.ConnectionInstructionP.SubscriptionARCCoreEnumMemberThe actual subscripton. This is what the connecting party / (downstream) client would send over its TCP/IP connection to the (upstream) server.
ARCAPI.BaseController.BuildControllerStorageARCAPIClassMemberBuilds a collection of 'std' (standard) controller instances to use for serving API requests.
ARCCore.IPAttributeARCCoreClassDescribes -IP- classes (describes at class-level)
ARCCore.ConnectionInstructionP.MultipleConnectionUsageARCCoreEnumMember 
ARCAPI.BaseController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCCore.CardinalityExtensionsARCCoreClass 
ARCCore.ConnectionInstructionP.ShardingARCCoreEnumMember 
ARCAPI.BaseController.CatchAllARCAPIClassMemberServes the typical single generic API method in an AgoRapide API.
ARCCore.CardinalityExtensions.IsMultipleARCCoreClassMemberReturns TRUE if given cardinality implies that multiple items are stored simultaneously in a typical in-memory data storage.
ARCCore.MultipleConnectionUsageARCCoreEnumEnables fault-tolerance by describing use of multiple connections
ARCAPI.BaseController.TryNavigateToLevelInDataStorageARCAPIClassMemberNavigates to the specified level (usually within -Storage-).
ARCCore.ExtensionsARCCoreClassContains a few general nice to have extensions methods.
ARCCore.MultipleConnectionUsage.AdminARCCoreEnumMemberConnection is a special administrative connection to a central 'command-and-control' server which instructs which connections to make.
ARCAPI.BaseController.GetFormatAndAdjustRequestARCAPIClassMemberDecides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).
ARCCore.Extensions.ToStringShortARCCoreClassMemberReturns a shorter representation than -ToStringDB-.
ARCCore.MultipleConnectionUsage.RoundRobinARCCoreEnumMemberThis connection to be used in a turn based system, together with other connections with -RoundRobin-.
ARCAPI.BaseController.GetTimestampIsOldWarningHTMLARCAPIClassMemberIf -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format.
ARCCore.Extensions.ToStringVeryShortARCCoreClassMemberReturns same as -ToStringShort- but without any generics information at all.
ARCCore.MultipleConnectionUsage.SimultaneousARCCoreEnumMemberThis connection to be used simultaneously with other connections with -Simultaneous-
ARCAPI.BaseController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.Extensions.ToStringDBARCCoreClassMemberGives the minimum representation of type as string suitable for later reconstruction by -GetType-.
ARCCore.StreamProcessorPARCCoreEnumDescribes class -StreamProcessor-.
ARCAPI.EditControllerARCAPIClassOffers a simple HTML editing environment of the raw -PropertyStream- from the given key.
ARCCore.Extensions.ForEachARCCoreClassMemberUseful when we want to write collection.ForEach( ... ) instead of
ARCCore.StreamProcessorP.LocalStorageFolderARCCoreEnumMemberThe local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar
ARCAPI.EditController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCCore.Extensions.UseARCCoreClassMemberConvenience method that shortens down code in cases where an instance of an object must be created first in order to use that same variable multiple times
ARCCore.StreamProcessorP.IndividualStorageFileSizeARCCoreEnumMemberMax size (in bytes) for a single storage file before a new file is created by call to -StreamProcessor.CreateNewStorageFile-.
ARCAPI.EditController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.Extensions.AddValueARCCoreClassMemberGives better error messages compared to 'original' Add when adding a value to a directory if key already exists
ARCCore.StreamProcessorP.CurrentlyInitializingARCCoreEnumMemberSet to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them).
ARCAPI.GQControllerARCAPIClassOffers GraphQL queries.
ARCCore.Extensions.KeysAsStringARCCoreClassMemberGives a compressed overview of keys in a dictionary. Helpful for building exception messages.
ARCCore.StreamProcessorP.ClientUpdatePositionPathARCCoreEnumMemberComplete path to file containing -ClientUpdatePosition-.
ARCAPI.GQController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCCore.Extensions.GetValueARCCoreClassMemberGives better error messages when reading value from directory if key does not exist
ARCCore.StreamProcessorP.ClientUpdatePositionARCCoreEnumMemberNote how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCAPI.GQController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.Extensions.SingleARCCoreClassMemberSame as inbuilt LINQ's Single except that gives a more friendly exception message
ARCCore.StreamProcessorP.IncomingConnectionsPortNoARCCoreEnumMemberIf not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-).
ARCAPI.RQControllerARCAPIClassRQ = REST Query. Executes a REST like query request against the given -DataStorage-.
ARCCore.Extensions.SingleOrDefaultARCCoreClassMemberSame as inbuilt LINQ's SingleOrDefault except that gives a more friendly exception message

Generated 2025-11-06 01:27:12.679 UTC