Class

Edit keys at this level only

Edit keys at all sub levels.
NOTE: Edits are always additive. Use 'Invalid' in order to delete keys.

__TOCDet/_Description = All classes with some AgoRapide specific attributes found in assembly ARCAPI
AddController/__TOCDet/Assembly = ARCAPI
AddController/__TOCDet/Description = Parses and stores a -PropertyStreamLine-.0x000D0x000AExample: https://yourserver.com/Add/dt/Customer/42/FirstName = John0x000D0x000A0x000D0x000ASends to -ExternalReceiver- if given.0x000D0x000AAdds to the given -DataStorage- unless -DoNotStoreInternally- is specified.0x000D0x000A0x000D0x000ABulk addition of data:0x000D0x000AIf HTTP POST is used and the parameter postData is given, then it will be treated as a collection of -PropertyStreamLine-s, to which the original request will be prepended for every line.0x000D0x000AExample:0x000D0x000AIf request is 'Add/Customer/42' and postData is the following two lines0x000D0x000A  FirstName = John0x000D0x000A  LastName = Smith0x000D0x000Athen it will be treated as two separate requests like0x000D0x000A  Add/Customer/42/FirstName = John0x000D0x000A  Add/Customer/42/LastName = Smith0x000D0x000A0x000D0x000ATODO: Support use of Query for adding values to multiple entities at once.0x000D0x000ATODO: like 'Add/Customer/WHERE FirstName = John/NameEvaluation = NiceName'0x000D0x000A0x000D0x000AHint: You can test input validation by using the inbuilt classes of -ARCDoc-.0x000D0x000A(assuming that the Apple and Orange classes are included in -AllIPDerivedTypes-.)0x000D0x000AExample queries:0x000D0x000Aapi/Add/Apple/1/Colour = Red   // Should succeed0x000D0x000Aapi/Add/Apple/1/Colour = Redd  // Should fail0x000D0x000Aapi/Add/Apple/1/Color = Red    // Does not fail since Apple class accepts any property (it inherits -PRich-).0x000D0x000Aapi/Add/Orange/1/Color = Red    // Sould fail since Orange accepts only Colour and Name (it inherits -PExact-).0x000D0x000A
AddController/__TOCDet/DocFragType = Class
AddController/__TOCDet/Name = AddController
AddController/__TOCDet/Namespace = ARCAPI
AddController/__TOCDet/Type = AddController
AddController/__TOCDet/Attribute/AssemblyName = ARCAPI
AddController/__TOCDet/Attribute/BaseTypes = PConcurrent0x003BBaseController
AddController/__TOCDet/Attribute/ClassNamespace = ARCAPI
AddController/__TOCDet/Attribute/ClassType = AddController
AddController/__TOCDet/Attribute/Description = Parses and stores a -PropertyStreamLine-.0x000D0x000AExample: https://yourserver.com/Add/dt/Customer/42/FirstName = John0x000D0x000A0x000D0x000ASends to -ExternalReceiver- if given.0x000D0x000AAdds to the given -DataStorage- unless -DoNotStoreInternally- is specified.0x000D0x000A0x000D0x000ABulk addition of data:0x000D0x000AIf HTTP POST is used and the parameter postData is given, then it will be treated as a collection of -PropertyStreamLine-s, to which the original request will be prepended for every line.0x000D0x000AExample:0x000D0x000AIf request is 'Add/Customer/42' and postData is the following two lines0x000D0x000A  FirstName = John0x000D0x000A  LastName = Smith0x000D0x000Athen it will be treated as two separate requests like0x000D0x000A  Add/Customer/42/FirstName = John0x000D0x000A  Add/Customer/42/LastName = Smith0x000D0x000A0x000D0x000ATODO: Support use of Query for adding values to multiple entities at once.0x000D0x000ATODO: like 'Add/Customer/WHERE FirstName = John/NameEvaluation = NiceName'0x000D0x000A0x000D0x000AHint: You can test input validation by using the inbuilt classes of -ARCDoc-.0x000D0x000A(assuming that the Apple and Orange classes are included in -AllIPDerivedTypes-.)0x000D0x000AExample queries:0x000D0x000Aapi/Add/Apple/1/Colour = Red   // Should succeed0x000D0x000Aapi/Add/Apple/1/Colour = Redd  // Should fail0x000D0x000Aapi/Add/Apple/1/Color = Red    // Does not fail since Apple class accepts any property (it inherits -PRich-).0x000D0x000Aapi/Add/Orange/1/Color = Red    // Sould fail since Orange accepts only Colour and Name (it inherits -PExact-).0x000D0x000A
AddController/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
AddController/AllowFilter/__TOCDet/Assembly = ARCAPI
AddController/AllowFilter/__TOCDet/Description = Describes what data is allowed to change through a list of -Subscription- instances.0x000D0x000A0x000D0x000ANot set (Null) by default, meaning that EVERYTHING may be changed0x000D0x000ASet to 'new List0x003CSubscription0x003E 0x007B Subscription.Parse("-*") 0x007D' if you want to disallow editing altogether.0x000D0x000A0x000D0x000AA typical setting could be the following list:0x000D0x000A  '+dt/'0x000D0x000AThat is, only allowing changes to -dt-.0x000D0x000A0x000D0x000A
AddController/AllowFilter/__TOCDet/DocFragType = ClassMember
AddController/AllowFilter/__TOCDet/IsInherited = False
AddController/AllowFilter/__TOCDet/IsInheritedDoc = False
AddController/AllowFilter/__TOCDet/Lines = 10
AddController/AllowFilter/__TOCDet/Name = AllowFilter
AddController/AllowFilter/__TOCDet/Namespace = ARCAPI
AddController/AllowFilter/__TOCDet/Type = AddController
AddController/AllowFilter/__TOCDet/Attribute/DeclaringType = AddController
AddController/AllowFilter/__TOCDet/Attribute/Description = Describes what data is allowed to change through a list of -Subscription- instances.0x000D0x000A0x000D0x000ANot set (Null) by default, meaning that EVERYTHING may be changed0x000D0x000ASet to 'new List0x003CSubscription0x003E 0x007B Subscription.Parse("-*") 0x007D' if you want to disallow editing altogether.0x000D0x000A0x000D0x000AA typical setting could be the following list:0x000D0x000A  '+dt/'0x000D0x000AThat is, only allowing changes to -dt-.0x000D0x000A0x000D0x000A
AddController/AllowFilter/__TOCDet/Attribute/MethodName = AllowFilter
AddController/AllowFilter/__TOCDet/Attribute/MethodSignature = System.Collections.Generic.List0x006010x005BARCCore.Subscription0x005D AllowFilter
AddController/APIMethod/__TOCDet/Assembly = ARCAPI
AddController/APIMethod/__TOCDet/Description = The (only) API method that this controller supports.0x000D0x000A0x000D0x000A
AddController/APIMethod/__TOCDet/DocFragType = ClassMember
AddController/APIMethod/__TOCDet/IsInherited = False
AddController/APIMethod/__TOCDet/IsInheritedDoc = True
AddController/APIMethod/__TOCDet/Name = APIMethod
AddController/APIMethod/__TOCDet/Namespace = ARCAPI
AddController/APIMethod/__TOCDet/Type = AddController
AddController/APIMethod/__TOCDet/Attribute/DeclaringType = BaseController
AddController/APIMethod/__TOCDet/Attribute/Description = The (only) API method that this controller supports.0x000D0x000A0x000D0x000A
AddController/APIMethod/__TOCDet/Attribute/MethodName = APIMethod
AddController/APIMethod/__TOCDet/Attribute/MethodSignature = ARCAPI.ContentResult APIMethod(ARCAPI.ResponseFormat, Int32, System.Collections.Generic.List0x006010x005BARCCore.IKCoded0x005D, System.String, ARCAPI.DataStorage)
AddController/ToString/__TOCDet/Assembly = ARCAPI
AddController/ToString/__TOCDet/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
AddController/ToString/__TOCDet/DocFragType = ClassMember
AddController/ToString/__TOCDet/IsInherited = True
AddController/ToString/__TOCDet/IsInheritedDoc = True
AddController/ToString/__TOCDet/Name = ToString
AddController/ToString/__TOCDet/Namespace = ARCAPI
AddController/ToString/__TOCDet/Type = AddController
AddController/ToString/__TOCDet/Attribute/DeclaringType = PConcurrent
AddController/ToString/__TOCDet/Attribute/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
AddController/ToString/__TOCDet/Attribute/MethodName = ToString
AddController/ToString/__TOCDet/Attribute/MethodSignature = System.String ToString()
BaseController/__TOCDet/Assembly = ARCAPI
BaseController/__TOCDet/Description = Contains basic functionality for serving API methods.0x000D0x000A0x000D0x000ARegarding -ExposingApplicationState-:0x000D0x000AThe specific controller instances serving requests are usually stored in a global -DataStorage- like 'app/0x007BnodeId0x007D/Controller/0x007BTypeOfController0x007D/0x007BControllerId0x007D...'.0x000D0x000A(in other words, -ControllerStorage- actually points to a branch inside -Storage-.)0x000D0x000A0x000D0x000AExamples of API requests and how they are resolved to a Controller by -CatchAll-:0x000D0x000AAPI request URL: https://yourserver.com/RQ/dt/Customer/42 0x000D0x000AController instance (in this case of type -RQController-) to be found in controllerStorage0x005B"RQController"0x005D0x000D0x000AMethod -APIMethod- is called on this instance.0x000D0x000A0x000D0x000AThe following controller classes are included within -ARCAPI-:0x000D0x000A0x000D0x000A-RQController-:0x000D0x000AExecutes a REST like query request against the given -DataStorage-.0x000D0x000AExample: https://yourserver.com/RQ/dt/Customer/42 0x000D0x000A0x000D0x000A-AddController-:0x000D0x000AParses and stores a -PropertyStreamLine-.0x000D0x000AExample: https://yourserver.com/Add/dt/Customer/42/FirstName = John0x000D0x000A0x000D0x000A-GQController-:0x000D0x000AOffers GraphQL queries.0x000D0x000ANot implemented as of Feb 2022.0x000D0x000A0x000D0x000A-EditController-:0x000D0x000AOffers a simple HTML editing environment of the raw -PropertyStream- from the given key.0x000D0x000AExample: https://yourserver.com/Edit/dt/Customer/420x000D0x000A0x000D0x000ANote how these controllers are sufficient for a basic CRUD API (Create, Read, Update, Delete).0x000D0x000A(Delete is done by using the metakey -Invalid-.)0x000D0x000A0x000D0x000AOften no additional -ApplicationSpecificCode- is needed.0x000D0x000A0x000D0x000A-ARCEvent- offers additional controllers of which the most important are -RSController- and -ESController- for operating against the -RegStream- and -EventStream- respectively.0x000D0x000A0x000D0x000ASee -BuildControllerStorage- for how -ApplicationSpecificCode- controllers are integrated.0x000D0x000A0x000D0x000AThis system has the following advantages:0x000D0x000A(Note: The concepts described below has shown little practical value as of Feb 2022).0x000D0x000A0x000D0x000A1) The API-routing syntax is by default exposed to the outside because the -ControllerStorage- is normally inserted into the global -DataStorage-.0x000D0x000ATherefore the standard query mechanism in AgoRapide can be used to get this information by querying like0x000D0x000A'RQ/log/0x005BnodeId0x005D/Controller'0x000D0x000A0x000D0x000A2) The API itself is discoverable even without querying like above, without much special code.0x000D0x000AThis is because an invalid API request is actually analyzed by the same mechanism answering standard queries.0x000D0x000AWhen the error message is returned it actually contains data about the correct syntax.0x000D0x000A0x000D0x000A3) The API is configurable both through the API itself and also over the -PropertyStream-.0x000D0x000AFor instance like 'Add/log/0x005BnodeId0x005D/Controller/RQ/~std/LogLevel = Warning' which would change the log level for the standard instance ('std') of -RQController- to 'Warning'.0x000D0x000A0x000D0x000A4) Different instances of the same controller type can exist and be configured individually.0x000D0x000AFor instance if some specific query needs additional logging down to debug level, a dedicated controller can be created for this and configured individually, like0x000D0x000A'Add/log/0x005BnodeId0x005D/Controller/RQController/~dbg/LogLevel = Debug'0x000D0x000A(Note: Such a debug controller is created by default by -BuildControllerStorage-).0x000D0x000A0x000D0x000ANOTE: Such specific controller instances can be used like 'RQ~dbg/...' instead of 'RQ/~dbg/...'. NOTE: This make inserted links more correct, for instance when -RQController- links to -EditController-0x000D0x000ANOTE: The reason for the somewhat special ~ prefix for the controller instance key is to avoid ambiguities NOTE: which are inherent because the complete hierarchical level has not been deemed necessary to specify explicitly.0x000D0x000A0x000D0x000ASome limitations of this approach are:0x000D0x000A1) Actual API method name is limited to the name of the controller type (without the 'Controller' part).0x000D0x000AThat is, a controller called CustomerController can only serve queries starting with 'Customer'.0x000D0x000A0x000D0x000ANote however that in your -ApplicationSpecificCode- you can implement any additional controllers with routing structure totally independent of this standard generic AgoRapide mechanism.0x000D0x000AIn other words, you can keep the AgoRapide mechanism for its standardised approach to data manipulation and add additional traditional controllers and methods as needed.0x000D0x000A0x000D0x000ANote how the -BaseController- classes (like this class) do not inherit any special Microsoft.AspNetCore.Mvc class. They are totally stand-alone with regard to Microsoft.AspNetCore.Mvc.0x000D0x000A0x000D0x000A
BaseController/__TOCDet/DocFragType = Class
BaseController/__TOCDet/Name = BaseController
BaseController/__TOCDet/Namespace = ARCAPI
BaseController/__TOCDet/Type = BaseController
BaseController/__TOCDet/Attribute/AssemblyName = ARCAPI
BaseController/__TOCDet/Attribute/BaseTypes = PConcurrent
BaseController/__TOCDet/Attribute/ClassNamespace = ARCAPI
BaseController/__TOCDet/Attribute/ClassType = BaseController
BaseController/__TOCDet/Attribute/CorrespondingEnumType = BaseControllerP
BaseController/__TOCDet/Attribute/Description = Contains basic functionality for serving API methods.0x000D0x000A0x000D0x000ARegarding -ExposingApplicationState-:0x000D0x000AThe specific controller instances serving requests are usually stored in a global -DataStorage- like 'app/0x007BnodeId0x007D/Controller/0x007BTypeOfController0x007D/0x007BControllerId0x007D...'.0x000D0x000A(in other words, -ControllerStorage- actually points to a branch inside -Storage-.)0x000D0x000A0x000D0x000AExamples of API requests and how they are resolved to a Controller by -CatchAll-:0x000D0x000AAPI request URL: https://yourserver.com/RQ/dt/Customer/42 0x000D0x000AController instance (in this case of type -RQController-) to be found in controllerStorage0x005B"RQController"0x005D0x000D0x000AMethod -APIMethod- is called on this instance.0x000D0x000A0x000D0x000AThe following controller classes are included within -ARCAPI-:0x000D0x000A0x000D0x000A-RQController-:0x000D0x000AExecutes a REST like query request against the given -DataStorage-.0x000D0x000AExample: https://yourserver.com/RQ/dt/Customer/42 0x000D0x000A0x000D0x000A-AddController-:0x000D0x000AParses and stores a -PropertyStreamLine-.0x000D0x000AExample: https://yourserver.com/Add/dt/Customer/42/FirstName = John0x000D0x000A0x000D0x000A-GQController-:0x000D0x000AOffers GraphQL queries.0x000D0x000ANot implemented as of Feb 2022.0x000D0x000A0x000D0x000A-EditController-:0x000D0x000AOffers a simple HTML editing environment of the raw -PropertyStream- from the given key.0x000D0x000AExample: https://yourserver.com/Edit/dt/Customer/420x000D0x000A0x000D0x000ANote how these controllers are sufficient for a basic CRUD API (Create, Read, Update, Delete).0x000D0x000A(Delete is done by using the metakey -Invalid-.)0x000D0x000A0x000D0x000AOften no additional -ApplicationSpecificCode- is needed.0x000D0x000A0x000D0x000A-ARCEvent- offers additional controllers of which the most important are -RSController- and -ESController- for operating against the -RegStream- and -EventStream- respectively.0x000D0x000A0x000D0x000ASee -BuildControllerStorage- for how -ApplicationSpecificCode- controllers are integrated.0x000D0x000A0x000D0x000AThis system has the following advantages:0x000D0x000A(Note: The concepts described below has shown little practical value as of Feb 2022).0x000D0x000A0x000D0x000A1) The API-routing syntax is by default exposed to the outside because the -ControllerStorage- is normally inserted into the global -DataStorage-.0x000D0x000ATherefore the standard query mechanism in AgoRapide can be used to get this information by querying like0x000D0x000A'RQ/log/0x005BnodeId0x005D/Controller'0x000D0x000A0x000D0x000A2) The API itself is discoverable even without querying like above, without much special code.0x000D0x000AThis is because an invalid API request is actually analyzed by the same mechanism answering standard queries.0x000D0x000AWhen the error message is returned it actually contains data about the correct syntax.0x000D0x000A0x000D0x000A3) The API is configurable both through the API itself and also over the -PropertyStream-.0x000D0x000AFor instance like 'Add/log/0x005BnodeId0x005D/Controller/RQ/~std/LogLevel = Warning' which would change the log level for the standard instance ('std') of -RQController- to 'Warning'.0x000D0x000A0x000D0x000A4) Different instances of the same controller type can exist and be configured individually.0x000D0x000AFor instance if some specific query needs additional logging down to debug level, a dedicated controller can be created for this and configured individually, like0x000D0x000A'Add/log/0x005BnodeId0x005D/Controller/RQController/~dbg/LogLevel = Debug'0x000D0x000A(Note: Such a debug controller is created by default by -BuildControllerStorage-).0x000D0x000A0x000D0x000ANOTE: Such specific controller instances can be used like 'RQ~dbg/...' instead of 'RQ/~dbg/...'. NOTE: This make inserted links more correct, for instance when -RQController- links to -EditController-0x000D0x000ANOTE: The reason for the somewhat special ~ prefix for the controller instance key is to avoid ambiguities NOTE: which are inherent because the complete hierarchical level has not been deemed necessary to specify explicitly.0x000D0x000A0x000D0x000ASome limitations of this approach are:0x000D0x000A1) Actual API method name is limited to the name of the controller type (without the 'Controller' part).0x000D0x000AThat is, a controller called CustomerController can only serve queries starting with 'Customer'.0x000D0x000A0x000D0x000ANote however that in your -ApplicationSpecificCode- you can implement any additional controllers with routing structure totally independent of this standard generic AgoRapide mechanism.0x000D0x000AIn other words, you can keep the AgoRapide mechanism for its standardised approach to data manipulation and add additional traditional controllers and methods as needed.0x000D0x000A0x000D0x000ANote how the -BaseController- classes (like this class) do not inherit any special Microsoft.AspNetCore.Mvc class. They are totally stand-alone with regard to Microsoft.AspNetCore.Mvc.0x000D0x000A0x000D0x000A
BaseController/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
BaseController/__TOCDet/Attribute/SubTypes = AddController0x003BEditController0x003BGQController0x003BRQController
BaseController/APIMethod/__TOCDet/Assembly = ARCAPI
BaseController/APIMethod/__TOCDet/Description = The (only) API method that this controller supports.0x000D0x000A0x000D0x000A
BaseController/APIMethod/__TOCDet/DocFragType = ClassMember
BaseController/APIMethod/__TOCDet/IsInherited = False
BaseController/APIMethod/__TOCDet/IsInheritedDoc = False
BaseController/APIMethod/__TOCDet/Lines = 3
BaseController/APIMethod/__TOCDet/Name = APIMethod
BaseController/APIMethod/__TOCDet/Namespace = ARCAPI
BaseController/APIMethod/__TOCDet/Type = BaseController
BaseController/APIMethod/__TOCDet/Attribute/DeclaringType = BaseController
BaseController/APIMethod/__TOCDet/Attribute/Description = The (only) API method that this controller supports.0x000D0x000A0x000D0x000A
BaseController/APIMethod/__TOCDet/Attribute/MethodName = APIMethod
BaseController/APIMethod/__TOCDet/Attribute/MethodSignature = ARCAPI.ContentResult APIMethod(ARCAPI.ResponseFormat, Int32, System.Collections.Generic.List0x006010x005BARCCore.IKCoded0x005D, System.String, ARCAPI.DataStorage)
BaseController/BuildControllerStorage/__TOCDet/Assembly = ARCAPI
BaseController/BuildControllerStorage/__TOCDet/Description = Builds a collection of 'std' (standard) controller instances to use for serving API requests.0x000D0x000A0x000D0x000AReflection is used to search the 'assemblies' parameter for classes implementing -BaseController-.0x000D0x000A0x000D0x000ANote that if the returned storage is coupled to the -PropertyStream- then additional elements may be added later, either through API methods or through -Subscription- (or the 'std' instances' properties may also be changed, through the same mechanisms).0x000D0x000A0x000D0x000ATODO: Consider moving this method to -DataStorage-.
BaseController/BuildControllerStorage/__TOCDet/DocFragType = ClassMember
BaseController/BuildControllerStorage/__TOCDet/IsInherited = False
BaseController/BuildControllerStorage/__TOCDet/IsInheritedDoc = False
BaseController/BuildControllerStorage/__TOCDet/Lines = 7
BaseController/BuildControllerStorage/__TOCDet/Name = BuildControllerStorage
BaseController/BuildControllerStorage/__TOCDet/Namespace = ARCAPI
BaseController/BuildControllerStorage/__TOCDet/Type = BaseController
BaseController/BuildControllerStorage/__TOCDet/Attribute/DeclaringType = BaseController
BaseController/BuildControllerStorage/__TOCDet/Attribute/Description = Builds a collection of 'std' (standard) controller instances to use for serving API requests.0x000D0x000A0x000D0x000AReflection is used to search the 'assemblies' parameter for classes implementing -BaseController-.0x000D0x000A0x000D0x000ANote that if the returned storage is coupled to the -PropertyStream- then additional elements may be added later, either through API methods or through -Subscription- (or the 'std' instances' properties may also be changed, through the same mechanisms).0x000D0x000A0x000D0x000ATODO: Consider moving this method to -DataStorage-.
BaseController/BuildControllerStorage/__TOCDet/Attribute/MethodName = BuildControllerStorage
BaseController/BuildControllerStorage/__TOCDet/Attribute/MethodSignature = ARCCore.IP BuildControllerStorage(System.Collections.Generic.IEnumerable0x006010x005BSystem.Reflection.Assembly0x005D)
BaseController/CatchAll/__TOCDet/Assembly = ARCAPI
BaseController/CatchAll/__TOCDet/Description = Serves the typical single generic API method in an AgoRapide API.0x000D0x000A0x000D0x000AFinds the correct controller to handle the query (from -ControllerStorage), and returns result from that controller.0x000D0x000A0x000D0x000AThe API-routing corresponds to the type name of the controller (without the 'Controller' part if desired) and optionally the ~id of the controller when other than the standard instance.0x000D0x000AFor -RQController-, the routing would typically be like this:0x000D0x000A  'RQ/0x005Bparameters0x005D'  (identical to 'RQController/0x005Bparameters0x005D').0x000D0x000AThe debug instance is available like this:0x000D0x000A  'RQ~dbg/0x005Bparameters0x005D'  (identical to 'RQ/~dbg/0x005Bparameters0x005D' / 'RQController~dbg/0x005Bparameters0x005D' / 'RQController/~dbg/0x005Bparameters0x005D').0x000D0x000A0x000D0x000AIf query does not 'reach' any controller, routing information is returned instead (from -ControllerStorage-).0x000D0x000AFor instance querying nothing at all will list corresponding information from -ControllerStorage- instead.0x000D0x000A0x000D0x000ANote how uses -Lock- in order to be thread safe in connection with -OutsideLocalReceiver-.
BaseController/CatchAll/__TOCDet/DocFragType = ClassMember
BaseController/CatchAll/__TOCDet/IsInherited = False
BaseController/CatchAll/__TOCDet/IsInheritedDoc = False
BaseController/CatchAll/__TOCDet/Lines = 14
BaseController/CatchAll/__TOCDet/Name = CatchAll
BaseController/CatchAll/__TOCDet/Namespace = ARCAPI
BaseController/CatchAll/__TOCDet/Type = BaseController
BaseController/CatchAll/__TOCDet/Attribute/DeclaringType = BaseController
BaseController/CatchAll/__TOCDet/Attribute/Description = Serves the typical single generic API method in an AgoRapide API.0x000D0x000A0x000D0x000AFinds the correct controller to handle the query (from -ControllerStorage), and returns result from that controller.0x000D0x000A0x000D0x000AThe API-routing corresponds to the type name of the controller (without the 'Controller' part if desired) and optionally the ~id of the controller when other than the standard instance.0x000D0x000AFor -RQController-, the routing would typically be like this:0x000D0x000A  'RQ/0x005Bparameters0x005D'  (identical to 'RQController/0x005Bparameters0x005D').0x000D0x000AThe debug instance is available like this:0x000D0x000A  'RQ~dbg/0x005Bparameters0x005D'  (identical to 'RQ/~dbg/0x005Bparameters0x005D' / 'RQController~dbg/0x005Bparameters0x005D' / 'RQController/~dbg/0x005Bparameters0x005D').0x000D0x000A0x000D0x000AIf query does not 'reach' any controller, routing information is returned instead (from -ControllerStorage-).0x000D0x000AFor instance querying nothing at all will list corresponding information from -ControllerStorage- instead.0x000D0x000A0x000D0x000ANote how uses -Lock- in order to be thread safe in connection with -OutsideLocalReceiver-.
BaseController/CatchAll/__TOCDet/Attribute/MethodName = CatchAll
BaseController/CatchAll/__TOCDet/Attribute/MethodSignature = ARCAPI.ContentResult CatchAll(System.String, System.String, ARCAPI.DataStorage)
BaseController/GetFormatAndAdjustRequest/__TOCDet/Assembly = ARCAPI
BaseController/GetFormatAndAdjustRequest/__TOCDet/Description = Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).0x000D0x000A0x000D0x000AFor Requests ending with /.html HTML-format is assumed, for .json JSON is assumed and so on.0x000D0x000A0x000D0x000ADefault format is -HTML-.0x000D0x000A0x000D0x000A.json may be given as .json0x007Bdepth0x007D indicating to which depth the serialization mechanism should work. 1 is default.0x000D0x000A0x000D0x000AIf a format is specified (as the end-item in the request item list) then that corresponding item is removed from list.0x000D0x000A0x000D0x000ATODO: Improve this, especially the index.html-part which is not generic
BaseController/GetFormatAndAdjustRequest/__TOCDet/DocFragType = ClassMember
BaseController/GetFormatAndAdjustRequest/__TOCDet/IsInherited = False
BaseController/GetFormatAndAdjustRequest/__TOCDet/IsInheritedDoc = False
BaseController/GetFormatAndAdjustRequest/__TOCDet/Lines = 11
BaseController/GetFormatAndAdjustRequest/__TOCDet/Name = GetFormatAndAdjustRequest
BaseController/GetFormatAndAdjustRequest/__TOCDet/Namespace = ARCAPI
BaseController/GetFormatAndAdjustRequest/__TOCDet/Type = BaseController
BaseController/GetFormatAndAdjustRequest/__TOCDet/Attribute/DeclaringType = BaseController
BaseController/GetFormatAndAdjustRequest/__TOCDet/Attribute/Description = Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).0x000D0x000A0x000D0x000AFor Requests ending with /.html HTML-format is assumed, for .json JSON is assumed and so on.0x000D0x000A0x000D0x000ADefault format is -HTML-.0x000D0x000A0x000D0x000A.json may be given as .json0x007Bdepth0x007D indicating to which depth the serialization mechanism should work. 1 is default.0x000D0x000A0x000D0x000AIf a format is specified (as the end-item in the request item list) then that corresponding item is removed from list.0x000D0x000A0x000D0x000ATODO: Improve this, especially the index.html-part which is not generic
BaseController/GetFormatAndAdjustRequest/__TOCDet/Attribute/MethodName = GetFormatAndAdjustRequest
BaseController/GetFormatAndAdjustRequest/__TOCDet/Attribute/MethodSignature = System.ValueTuple0x006020x005BARCAPI.ResponseFormat,System.Int320x005D GetFormatAndAdjustRequest(System.Collections.Generic.List0x006010x005BSystem.String0x005D ByRef)
BaseController/GetTimestampIsOldWarningHTML/__TOCDet/Assembly = ARCAPI
BaseController/GetTimestampIsOldWarningHTML/__TOCDet/Description = If -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format.0x000D0x000AOtherwise, empty string is returned.
BaseController/GetTimestampIsOldWarningHTML/__TOCDet/DocFragType = ClassMember
BaseController/GetTimestampIsOldWarningHTML/__TOCDet/IsInherited = False
BaseController/GetTimestampIsOldWarningHTML/__TOCDet/IsInheritedDoc = False
BaseController/GetTimestampIsOldWarningHTML/__TOCDet/Lines = 2
BaseController/GetTimestampIsOldWarningHTML/__TOCDet/Name = GetTimestampIsOldWarningHTML
BaseController/GetTimestampIsOldWarningHTML/__TOCDet/Namespace = ARCAPI
BaseController/GetTimestampIsOldWarningHTML/__TOCDet/Type = BaseController
BaseController/GetTimestampIsOldWarningHTML/__TOCDet/Attribute/DeclaringType = BaseController
BaseController/GetTimestampIsOldWarningHTML/__TOCDet/Attribute/Description = If -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format.0x000D0x000AOtherwise, empty string is returned.
BaseController/GetTimestampIsOldWarningHTML/__TOCDet/Attribute/MethodName = GetTimestampIsOldWarningHTML
BaseController/GetTimestampIsOldWarningHTML/__TOCDet/Attribute/MethodSignature = System.String GetTimestampIsOldWarningHTML(ARCCore.IP)
BaseController/ToString/__TOCDet/Assembly = ARCAPI
BaseController/ToString/__TOCDet/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
BaseController/ToString/__TOCDet/DocFragType = ClassMember
BaseController/ToString/__TOCDet/IsInherited = True
BaseController/ToString/__TOCDet/IsInheritedDoc = True
BaseController/ToString/__TOCDet/Name = ToString
BaseController/ToString/__TOCDet/Namespace = ARCAPI
BaseController/ToString/__TOCDet/Type = BaseController
BaseController/ToString/__TOCDet/Attribute/DeclaringType = PConcurrent
BaseController/ToString/__TOCDet/Attribute/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
BaseController/ToString/__TOCDet/Attribute/MethodName = ToString
BaseController/ToString/__TOCDet/Attribute/MethodSignature = System.String ToString()
BaseController/TryNavigateToLevelInDataStorage/__TOCDet/Assembly = ARCAPI
BaseController/TryNavigateToLevelInDataStorage/__TOCDet/Description = Navigates to the specified level (usually within -Storage-).0x000D0x000A0x000D0x000AIf unsuccesful returns a corresponding error message with link to last 'correct' level.0x000D0x000AExample: If attempting to navigate to 'Customer/42/MiddleName' but 'MiddleName' does not exist, will offer link to Customer/42.0x000D0x000A0x000D0x000AIf unsuccessful, then the out-parameter errorResponseHTML will also contain an eventual warning from -GetTimestampIsOldWarningHTML-.0x000D0x000AThis is pertinent in cases where the actual key has just not been read yet from the -PropertyStream--storage.0x000D0x000A0x000D0x000AAlso able to understand and parse -QueryExpression-.0x000D0x000A0x000D0x000ANote that also used for navigating within -ControllerStorage-, that is, to route an API-method to the desired controller.0x000D0x000A0x000D0x000ATODO: This concept is quite generic. It is useful also in console applications and similar.0x000D0x000ATODO: Move to ARCCore instead.
BaseController/TryNavigateToLevelInDataStorage/__TOCDet/DocFragType = ClassMember
BaseController/TryNavigateToLevelInDataStorage/__TOCDet/IsInherited = False
BaseController/TryNavigateToLevelInDataStorage/__TOCDet/IsInheritedDoc = False
BaseController/TryNavigateToLevelInDataStorage/__TOCDet/Lines = 14
BaseController/TryNavigateToLevelInDataStorage/__TOCDet/Name = TryNavigateToLevelInDataStorage
BaseController/TryNavigateToLevelInDataStorage/__TOCDet/Namespace = ARCAPI
BaseController/TryNavigateToLevelInDataStorage/__TOCDet/Type = BaseController
BaseController/TryNavigateToLevelInDataStorage/__TOCDet/Attribute/DeclaringType = BaseController
BaseController/TryNavigateToLevelInDataStorage/__TOCDet/Attribute/Description = Navigates to the specified level (usually within -Storage-).0x000D0x000A0x000D0x000AIf unsuccesful returns a corresponding error message with link to last 'correct' level.0x000D0x000AExample: If attempting to navigate to 'Customer/42/MiddleName' but 'MiddleName' does not exist, will offer link to Customer/42.0x000D0x000A0x000D0x000AIf unsuccessful, then the out-parameter errorResponseHTML will also contain an eventual warning from -GetTimestampIsOldWarningHTML-.0x000D0x000AThis is pertinent in cases where the actual key has just not been read yet from the -PropertyStream--storage.0x000D0x000A0x000D0x000AAlso able to understand and parse -QueryExpression-.0x000D0x000A0x000D0x000ANote that also used for navigating within -ControllerStorage-, that is, to route an API-method to the desired controller.0x000D0x000A0x000D0x000ATODO: This concept is quite generic. It is useful also in console applications and similar.0x000D0x000ATODO: Move to ARCCore instead.
BaseController/TryNavigateToLevelInDataStorage/__TOCDet/Attribute/MethodName = TryNavigateToLevelInDataStorage
BaseController/TryNavigateToLevelInDataStorage/__TOCDet/Attribute/MethodSignature = Boolean TryNavigateToLevelInDataStorage(ARCAPI.DataStorage, System.Collections.Generic.List0x006010x005BARCCore.IKCoded0x005D, ARCAPI.BaseController, System.ValueTuple0x006020x005BSystem.Collections.Generic.List0x006010x005BARCCore.IKCoded0x005D,ARCCore.IP0x005D ByRef, System.String ByRef, ARCCore.IP)
ContentResult/__TOCDet/Assembly = ARCAPI
ContentResult/__TOCDet/Description = Mimicks Microsoft.AspNetCore.Mvc.ContentResult.0x000D0x000A0x000D0x000ANote that although -ARCAPI- is supposed to work with a Microsoft.AspNetCore.Mvc application, it does not link to the Microsoft.AspNetCore.Mvc library itself.0x000D0x000ATherefore the returned instance from controller methods like -APIMethod- or -APIMethod-) is not an instance of Microsoft.AspNetCore.Mvc.ContentResult (or Microsoft.AspNetCore.Mvc.ActionResult) but rather an instance of this class, AgoRapide -ContentResult-.0x000D0x000A0x000D0x000AThis class reflects the components needed to construct a Microsoft.AspNetCore.Mvc.ContentResult instance, namely 0x000D0x000A'(string Content, string ContentType, System.Net.HttpStatusCode StatusCode)'.0x000D0x000A0x000D0x000AThis class is immutable.0x000D0x000A
ContentResult/__TOCDet/DocFragType = Class
ContentResult/__TOCDet/Name = ContentResult
ContentResult/__TOCDet/Namespace = ARCAPI
ContentResult/__TOCDet/Type = ContentResult
ContentResult/__TOCDet/Attribute/AssemblyName = ARCAPI
ContentResult/__TOCDet/Attribute/ClassNamespace = ARCAPI
ContentResult/__TOCDet/Attribute/ClassType = ContentResult
ContentResult/__TOCDet/Attribute/Description = Mimicks Microsoft.AspNetCore.Mvc.ContentResult.0x000D0x000A0x000D0x000ANote that although -ARCAPI- is supposed to work with a Microsoft.AspNetCore.Mvc application, it does not link to the Microsoft.AspNetCore.Mvc library itself.0x000D0x000ATherefore the returned instance from controller methods like -APIMethod- or -APIMethod-) is not an instance of Microsoft.AspNetCore.Mvc.ContentResult (or Microsoft.AspNetCore.Mvc.ActionResult) but rather an instance of this class, AgoRapide -ContentResult-.0x000D0x000A0x000D0x000AThis class reflects the components needed to construct a Microsoft.AspNetCore.Mvc.ContentResult instance, namely 0x000D0x000A'(string Content, string ContentType, System.Net.HttpStatusCode StatusCode)'.0x000D0x000A0x000D0x000AThis class is immutable.0x000D0x000A
ContentResult/CreateError/__TOCDet/Assembly = ARCAPI
ContentResult/CreateError/__TOCDet/Description = TODO: Add a key / value format for error messages, like done for -Log-.
ContentResult/CreateError/__TOCDet/DocFragType = ClassMember
ContentResult/CreateError/__TOCDet/IsInherited = False
ContentResult/CreateError/__TOCDet/IsInheritedDoc = False
ContentResult/CreateError/__TOCDet/Lines = 1
ContentResult/CreateError/__TOCDet/Name = CreateError
ContentResult/CreateError/__TOCDet/Namespace = ARCAPI
ContentResult/CreateError/__TOCDet/Type = ContentResult
ContentResult/CreateError/__TOCDet/Attribute/DeclaringType = ContentResult
ContentResult/CreateError/__TOCDet/Attribute/Description = TODO: Add a key / value format for error messages, like done for -Log-.
ContentResult/CreateError/__TOCDet/Attribute/MethodName = CreateError
ContentResult/CreateError/__TOCDet/Attribute/MethodSignature = ARCAPI.ContentResult CreateError(ARCAPI.ResponseFormat, System.String)
ContentResult/CreateHTMLOK/__TOCDet/Assembly = ARCAPI
ContentResult/CreateHTMLOK/__TOCDet/Description = NOTE: Parameter must be a complete HTML page.0x000D0x000AHINT: Use -GenerateHTMLPage- in order to create parameter.
ContentResult/CreateHTMLOK/__TOCDet/DocFragType = ClassMember
ContentResult/CreateHTMLOK/__TOCDet/IsInherited = False
ContentResult/CreateHTMLOK/__TOCDet/IsInheritedDoc = False
ContentResult/CreateHTMLOK/__TOCDet/Lines = 2
ContentResult/CreateHTMLOK/__TOCDet/Name = CreateHTMLOK
ContentResult/CreateHTMLOK/__TOCDet/Namespace = ARCAPI
ContentResult/CreateHTMLOK/__TOCDet/Type = ContentResult
ContentResult/CreateHTMLOK/__TOCDet/Attribute/DeclaringType = ContentResult
ContentResult/CreateHTMLOK/__TOCDet/Attribute/Description = NOTE: Parameter must be a complete HTML page.0x000D0x000AHINT: Use -GenerateHTMLPage- in order to create parameter.
ContentResult/CreateHTMLOK/__TOCDet/Attribute/MethodName = CreateHTMLOK
ContentResult/CreateHTMLOK/__TOCDet/Attribute/MethodSignature = ARCAPI.ContentResult CreateHTMLOK(System.String)
DataStorage/__TOCDet/Assembly = ARCAPI
DataStorage/__TOCDet/Description = The all-in-memory global application data storage.0x000D0x000A0x000D0x000ADoes also contain the necessary global locking object for thread-safe access (-Lock-).0x000D0x000A0x000D0x000AIs usually accessed within -ARAAPI- as a static instance Program.DataStorage.0x000D0x000A0x000D0x000ACan be kept up to date by -Subscription- to -PropertyStream- (see -OutsideLocalReceiver-).0x000D0x000A0x000D0x000AWill usually contain (in addition to -dt-), also other 'branches' like -app- and -doc-.0x000D0x000A0x000D0x000ASee constructor for information about -ExposingApplicationState- through this class.0x000D0x000A0x000D0x000AThis class is immutable.
DataStorage/__TOCDet/DocFragType = Class
DataStorage/__TOCDet/Name = DataStorage
DataStorage/__TOCDet/Namespace = ARCAPI
DataStorage/__TOCDet/Type = DataStorage
DataStorage/__TOCDet/Attribute/AssemblyName = ARCAPI
DataStorage/__TOCDet/Attribute/ClassNamespace = ARCAPI
DataStorage/__TOCDet/Attribute/ClassType = DataStorage
DataStorage/__TOCDet/Attribute/Description = The all-in-memory global application data storage.0x000D0x000A0x000D0x000ADoes also contain the necessary global locking object for thread-safe access (-Lock-).0x000D0x000A0x000D0x000AIs usually accessed within -ARAAPI- as a static instance Program.DataStorage.0x000D0x000A0x000D0x000ACan be kept up to date by -Subscription- to -PropertyStream- (see -OutsideLocalReceiver-).0x000D0x000A0x000D0x000AWill usually contain (in addition to -dt-), also other 'branches' like -app- and -doc-.0x000D0x000A0x000D0x000ASee constructor for information about -ExposingApplicationState- through this class.0x000D0x000A0x000D0x000AThis class is immutable.
DataStorage/.ctor/__TOCDet/Assembly = ARCAPI
DataStorage/.ctor/__TOCDet/Description = This method will:0x000D0x000AInitialize -Storage-,0x000D0x000AInitialize -ControllerStorage-.0x000D0x000A
DataStorage/.ctor/__TOCDet/DocFragType = ClassMember
DataStorage/.ctor/__TOCDet/IsInherited = False
DataStorage/.ctor/__TOCDet/IsInheritedDoc = False
DataStorage/.ctor/__TOCDet/Lines = 4
DataStorage/.ctor/__TOCDet/Name = .ctor
DataStorage/.ctor/__TOCDet/Namespace = ARCAPI
DataStorage/.ctor/__TOCDet/Type = DataStorage
DataStorage/.ctor/__TOCDet/Attribute/DeclaringType = DataStorage
DataStorage/.ctor/__TOCDet/Attribute/Description = This method will:0x000D0x000AInitialize -Storage-,0x000D0x000AInitialize -ControllerStorage-.0x000D0x000A
DataStorage/.ctor/__TOCDet/Attribute/MethodName = .ctor
DataStorage/.ctor/__TOCDet/Attribute/MethodSignature = Void .ctor(ARCCore.IK, System.Collections.Generic.IEnumerable0x006010x005BSystem.Reflection.Assembly0x005D, Boolean, ARCCore.IP)
DataStorage/ControllerStorage/__TOCDet/Assembly = ARCAPI
DataStorage/ControllerStorage/__TOCDet/Description = Usually (but not always) a branch of -Storage- (like Storage0x005B"log"0x005D0x005B"0x007BnodeId0x007D"0x005D0x005B"Controller"0x005D).0x000D0x000A0x000D0x000AEnables -BaseController-.- CatchAll- to dispatch an API request to the correct controller.0x000D0x000A0x000D0x000ASee -BuildControllerStorage- for documentation.0x000D0x000A0x000D0x000A
DataStorage/ControllerStorage/__TOCDet/DocFragType = ClassMember
DataStorage/ControllerStorage/__TOCDet/IsInherited = False
DataStorage/ControllerStorage/__TOCDet/IsInheritedDoc = False
DataStorage/ControllerStorage/__TOCDet/Lines = 7
DataStorage/ControllerStorage/__TOCDet/Name = ControllerStorage
DataStorage/ControllerStorage/__TOCDet/Namespace = ARCAPI
DataStorage/ControllerStorage/__TOCDet/Type = DataStorage
DataStorage/ControllerStorage/__TOCDet/Attribute/DeclaringType = DataStorage
DataStorage/ControllerStorage/__TOCDet/Attribute/Description = Usually (but not always) a branch of -Storage- (like Storage0x005B"log"0x005D0x005B"0x007BnodeId0x007D"0x005D0x005B"Controller"0x005D).0x000D0x000A0x000D0x000AEnables -BaseController-.- CatchAll- to dispatch an API request to the correct controller.0x000D0x000A0x000D0x000ASee -BuildControllerStorage- for documentation.0x000D0x000A0x000D0x000A
DataStorage/ControllerStorage/__TOCDet/Attribute/MethodName = ControllerStorage
DataStorage/ControllerStorage/__TOCDet/Attribute/MethodSignature = ARCCore.IP ControllerStorage
DataStorage/Create/__TOCDet/Assembly = ARCAPI
DataStorage/Create/__TOCDet/Description = Creates a -DataStorage- instance with default parameters.0x000D0x000A0x000D0x000ANote: You are not obliged to use this method, you can call constructor directly instead and set up this instance 'manually'.0x000D0x000A0x000D0x000AThis method will:0x000D0x000ACall constructor with assemblies from -UtilCore-.-Assemblies- and -DoNotStoreInternally- FALSE,0x000D0x000ACreate -dt- container (if not already set)r0x000ACreate -doc- container with -Documentator-,0x000D0x000ASet -DocLinks-,0x000D0x000AConnect -ExternalReceiver- to -SendFromLocalOrigin- and0x000D0x000ACreate -app- container with data about -StreamProcessor-, -ControllerStorage-, -IPRelationsKeysPointingTo- and -IPRelationsKeysPointingFrom-.
DataStorage/Create/__TOCDet/DocFragType = ClassMember
DataStorage/Create/__TOCDet/IsInherited = False
DataStorage/Create/__TOCDet/IsInheritedDoc = False
DataStorage/Create/__TOCDet/Lines = 10
DataStorage/Create/__TOCDet/Name = Create
DataStorage/Create/__TOCDet/Namespace = ARCAPI
DataStorage/Create/__TOCDet/Type = DataStorage
DataStorage/Create/__TOCDet/Attribute/DeclaringType = DataStorage
DataStorage/Create/__TOCDet/Attribute/Description = Creates a -DataStorage- instance with default parameters.0x000D0x000A0x000D0x000ANote: You are not obliged to use this method, you can call constructor directly instead and set up this instance 'manually'.0x000D0x000A0x000D0x000AThis method will:0x000D0x000ACall constructor with assemblies from -UtilCore-.-Assemblies- and -DoNotStoreInternally- FALSE,0x000D0x000ACreate -dt- container (if not already set)r0x000ACreate -doc- container with -Documentator-,0x000D0x000ASet -DocLinks-,0x000D0x000AConnect -ExternalReceiver- to -SendFromLocalOrigin- and0x000D0x000ACreate -app- container with data about -StreamProcessor-, -ControllerStorage-, -IPRelationsKeysPointingTo- and -IPRelationsKeysPointingFrom-.
DataStorage/Create/__TOCDet/Attribute/MethodName = Create
DataStorage/Create/__TOCDet/Attribute/MethodSignature = ARCAPI.DataStorage Create(ARCCore.IK, ARCCore.IP, ARCCore.StreamProcessor, Boolean)
DataStorage/DocLinks/__TOCDet/Assembly = ARCAPI
DataStorage/DocLinks/__TOCDet/Description = Note that may be null.0x000D0x000A0x000D0x000AA collection of relevant keys from -Storage-, usually limited to Storage0x005B"doc"0x005D.0x000D0x000A0x000D0x000AEnables -LinkInsertionInDocumentation-.0x000D0x000AOriginates (normally) from -DocLinkCollection-.-Create-.0x000D0x000A0x000D0x000AMost relevant when querying (static) documentation because when storage is static then this parameter can be pre-calculated at application startup.0x000D0x000AIf on the other hand documentation storage is dynamically updated throughout the application lifetime then this parameter must also be continously updated, something which could have an unacceptable performance impact.0x000D0x000A0x000D0x000AOften set at application startup with links to (static) documentation.0x000D0x000AThis will improve error message for instance, by enabling linking directy to the documentation in the error message.0x000D0x000A0x000D0x000ANOTE: From Dec 2021 it it ASSUMED in AgoRapide in general that content here is static and will not change,0x000D0x000ANOTE: In other words, that content may be accessed without any locking (see -Lock-).0x000D0x000ANOTE: This significantly reduces the performance impact of NOTE: -LinkInsertionInDocumentation-.
DataStorage/DocLinks/__TOCDet/DocFragType = ClassMember
DataStorage/DocLinks/__TOCDet/IsInherited = False
DataStorage/DocLinks/__TOCDet/IsInheritedDoc = False
DataStorage/DocLinks/__TOCDet/Lines = 16
DataStorage/DocLinks/__TOCDet/Name = DocLinks
DataStorage/DocLinks/__TOCDet/Namespace = ARCAPI
DataStorage/DocLinks/__TOCDet/Type = DataStorage
DataStorage/DocLinks/__TOCDet/Attribute/DeclaringType = DataStorage
DataStorage/DocLinks/__TOCDet/Attribute/Description = Note that may be null.0x000D0x000A0x000D0x000AA collection of relevant keys from -Storage-, usually limited to Storage0x005B"doc"0x005D.0x000D0x000A0x000D0x000AEnables -LinkInsertionInDocumentation-.0x000D0x000AOriginates (normally) from -DocLinkCollection-.-Create-.0x000D0x000A0x000D0x000AMost relevant when querying (static) documentation because when storage is static then this parameter can be pre-calculated at application startup.0x000D0x000AIf on the other hand documentation storage is dynamically updated throughout the application lifetime then this parameter must also be continously updated, something which could have an unacceptable performance impact.0x000D0x000A0x000D0x000AOften set at application startup with links to (static) documentation.0x000D0x000AThis will improve error message for instance, by enabling linking directy to the documentation in the error message.0x000D0x000A0x000D0x000ANOTE: From Dec 2021 it it ASSUMED in AgoRapide in general that content here is static and will not change,0x000D0x000ANOTE: In other words, that content may be accessed without any locking (see -Lock-).0x000D0x000ANOTE: This significantly reduces the performance impact of NOTE: -LinkInsertionInDocumentation-.
DataStorage/DocLinks/__TOCDet/Attribute/MethodName = DocLinks
DataStorage/DocLinks/__TOCDet/Attribute/MethodSignature = ARCDoc.DocLinkCollection DocLinks
DataStorage/DoNotStoreInternally/__TOCDet/Assembly = ARCAPI
DataStorage/DoNotStoreInternally/__TOCDet/Description = Typically used by -AddController-.0x000D0x000A0x000D0x000ASignals that properties should not be added to -DataStorage- directly. 0x000D0x000AWill typically be used in situations where one wants to ensure that data is actually added to -CoreDB- before showing it in the API. This would again typically be implemented by using -ExternalReceiver- and waiting for the data to come back over a -Subscription- to the -PropertyStream-.0x000D0x000A0x000D0x000ANOTE: As of Jun 2020 there is no mechanism in AgoRapide for ensuring that this actually happens other than for the client to use polling against the API to ensure that the round-trip to the core and back has completed.0x000D0x000A0x000D0x000ANote: It is meaningless to have -DoNotStoreInternally = FALSE and -ExternalReceiver- = NULL at the same time.
DataStorage/DoNotStoreInternally/__TOCDet/DocFragType = ClassMember
DataStorage/DoNotStoreInternally/__TOCDet/IsInherited = False
DataStorage/DoNotStoreInternally/__TOCDet/IsInheritedDoc = False
DataStorage/DoNotStoreInternally/__TOCDet/Lines = 8
DataStorage/DoNotStoreInternally/__TOCDet/Name = DoNotStoreInternally
DataStorage/DoNotStoreInternally/__TOCDet/Namespace = ARCAPI
DataStorage/DoNotStoreInternally/__TOCDet/Type = DataStorage
DataStorage/DoNotStoreInternally/__TOCDet/Attribute/DeclaringType = DataStorage
DataStorage/DoNotStoreInternally/__TOCDet/Attribute/Description = Typically used by -AddController-.0x000D0x000A0x000D0x000ASignals that properties should not be added to -DataStorage- directly. 0x000D0x000AWill typically be used in situations where one wants to ensure that data is actually added to -CoreDB- before showing it in the API. This would again typically be implemented by using -ExternalReceiver- and waiting for the data to come back over a -Subscription- to the -PropertyStream-.0x000D0x000A0x000D0x000ANOTE: As of Jun 2020 there is no mechanism in AgoRapide for ensuring that this actually happens other than for the client to use polling against the API to ensure that the round-trip to the core and back has completed.0x000D0x000A0x000D0x000ANote: It is meaningless to have -DoNotStoreInternally = FALSE and -ExternalReceiver- = NULL at the same time.
DataStorage/DoNotStoreInternally/__TOCDet/Attribute/MethodName = DoNotStoreInternally
DataStorage/DoNotStoreInternally/__TOCDet/Attribute/MethodSignature = Boolean DoNotStoreInternally
DataStorage/ExternalReceiver/__TOCDet/Assembly = ARCAPI
DataStorage/ExternalReceiver/__TOCDet/Description = Typically used by -AddController-. 0x000D0x000AWill normally be a method calling -SendFromLocalOrigin-.0x000D0x000A0x000D0x000ANote: It is meaningless to have -DoNotStoreInternally = FALSE and -ExternalReceiver- = NULL at the same time.
DataStorage/ExternalReceiver/__TOCDet/DocFragType = ClassMember
DataStorage/ExternalReceiver/__TOCDet/IsInherited = False
DataStorage/ExternalReceiver/__TOCDet/IsInheritedDoc = False
DataStorage/ExternalReceiver/__TOCDet/Lines = 4
DataStorage/ExternalReceiver/__TOCDet/Name = ExternalReceiver
DataStorage/ExternalReceiver/__TOCDet/Namespace = ARCAPI
DataStorage/ExternalReceiver/__TOCDet/Type = DataStorage
DataStorage/ExternalReceiver/__TOCDet/Attribute/DeclaringType = DataStorage
DataStorage/ExternalReceiver/__TOCDet/Attribute/Description = Typically used by -AddController-. 0x000D0x000AWill normally be a method calling -SendFromLocalOrigin-.0x000D0x000A0x000D0x000ANote: It is meaningless to have -DoNotStoreInternally = FALSE and -ExternalReceiver- = NULL at the same time.
DataStorage/ExternalReceiver/__TOCDet/Attribute/MethodName = ExternalReceiver
DataStorage/ExternalReceiver/__TOCDet/Attribute/MethodSignature = System.Action0x006010x005BSystem.String0x005D ExternalReceiver
DataStorage/Lock/__TOCDet/Assembly = ARCAPI
DataStorage/Lock/__TOCDet/Description = Locking object for thread-safe access from simultaneous API requests.0x000D0x000A0x000D0x000A-BaseController- components like -RQController- and -EditController- (offering HTML forms POSTing to -AddController-) will typically need to acquire a Read lock (EnterReadLock),0x000D0x000Awhile components like -AddController- will typically need to acquire a Write lock (EnterWriteLock).0x000D0x000A0x000D0x000ALocking is also need by when keeping storage up-to-date by -Subscription- to -PropertyStream- through -OutsideLocalReceiver-.0x000D0x000A0x000D0x000AIn -ARCEvent- typical components requiring read locks are -ProcessController-, -ESController- and -UIController- while -ASController- requires first a read lock (for parsing) and then a write lock.0x000D0x000A0x000D0x000ANOTE: It is assumed that -DocLinks- can be accessed without locking0x000D0x000ANOTE: (see under -DocLinks- for details).
DataStorage/Lock/__TOCDet/DocFragType = ClassMember
DataStorage/Lock/__TOCDet/IsInherited = False
DataStorage/Lock/__TOCDet/IsInheritedDoc = False
DataStorage/Lock/__TOCDet/Lines = 11
DataStorage/Lock/__TOCDet/Name = Lock
DataStorage/Lock/__TOCDet/Namespace = ARCAPI
DataStorage/Lock/__TOCDet/Type = DataStorage
DataStorage/Lock/__TOCDet/Attribute/DeclaringType = DataStorage
DataStorage/Lock/__TOCDet/Attribute/Description = Locking object for thread-safe access from simultaneous API requests.0x000D0x000A0x000D0x000A-BaseController- components like -RQController- and -EditController- (offering HTML forms POSTing to -AddController-) will typically need to acquire a Read lock (EnterReadLock),0x000D0x000Awhile components like -AddController- will typically need to acquire a Write lock (EnterWriteLock).0x000D0x000A0x000D0x000ALocking is also need by when keeping storage up-to-date by -Subscription- to -PropertyStream- through -OutsideLocalReceiver-.0x000D0x000A0x000D0x000AIn -ARCEvent- typical components requiring read locks are -ProcessController-, -ESController- and -UIController- while -ASController- requires first a read lock (for parsing) and then a write lock.0x000D0x000A0x000D0x000ANOTE: It is assumed that -DocLinks- can be accessed without locking0x000D0x000ANOTE: (see under -DocLinks- for details).
DataStorage/Lock/__TOCDet/Attribute/MethodName = Lock
DataStorage/Lock/__TOCDet/Attribute/MethodSignature = System.Threading.ReaderWriterLockSlim Lock
DataStorage/Storage/__TOCDet/Assembly = ARCAPI
DataStorage/Storage/__TOCDet/Description = The actual storage.0x000D0x000A0x000D0x000AThe root-pointer to all objects stored.
DataStorage/Storage/__TOCDet/DocFragType = ClassMember
DataStorage/Storage/__TOCDet/IsInherited = False
DataStorage/Storage/__TOCDet/IsInheritedDoc = False
DataStorage/Storage/__TOCDet/Lines = 3
DataStorage/Storage/__TOCDet/Name = Storage
DataStorage/Storage/__TOCDet/Namespace = ARCAPI
DataStorage/Storage/__TOCDet/Type = DataStorage
DataStorage/Storage/__TOCDet/Attribute/DeclaringType = DataStorage
DataStorage/Storage/__TOCDet/Attribute/Description = The actual storage.0x000D0x000A0x000D0x000AThe root-pointer to all objects stored.
DataStorage/Storage/__TOCDet/Attribute/MethodName = Storage
DataStorage/Storage/__TOCDet/Attribute/MethodSignature = ARCCore.IP Storage
EditController/__TOCDet/Assembly = ARCAPI
EditController/__TOCDet/Description = Offers a simple HTML editing environment of the raw -PropertyStream- from the given key.0x000D0x000AExample: https://yourserver.com/Edit/dt/Customer/420x000D0x000A0x000D0x000AThe HTML form offered will POST directly to -AddController- with the postData-parameter set.0x000D0x000A0x000D0x000ATODO: Note that -JSON- is currently not supported.0x000D0x000ATODO: It might appear to be irrelevant, but it could contain the basic elements for building an HTML editing environment,0x000D0x000ATODO: enabling to client to construct its own HTML page.
EditController/__TOCDet/DocFragType = Class
EditController/__TOCDet/Name = EditController
EditController/__TOCDet/Namespace = ARCAPI
EditController/__TOCDet/Type = EditController
EditController/__TOCDet/Attribute/AssemblyName = ARCAPI
EditController/__TOCDet/Attribute/BaseTypes = PConcurrent0x003BBaseController
EditController/__TOCDet/Attribute/ClassNamespace = ARCAPI
EditController/__TOCDet/Attribute/ClassType = EditController
EditController/__TOCDet/Attribute/Description = Offers a simple HTML editing environment of the raw -PropertyStream- from the given key.0x000D0x000AExample: https://yourserver.com/Edit/dt/Customer/420x000D0x000A0x000D0x000AThe HTML form offered will POST directly to -AddController- with the postData-parameter set.0x000D0x000A0x000D0x000ATODO: Note that -JSON- is currently not supported.0x000D0x000ATODO: It might appear to be irrelevant, but it could contain the basic elements for building an HTML editing environment,0x000D0x000ATODO: enabling to client to construct its own HTML page.
EditController/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
EditController/APIMethod/__TOCDet/Assembly = ARCAPI
EditController/APIMethod/__TOCDet/Description = The (only) API method that this controller supports.0x000D0x000A0x000D0x000A
EditController/APIMethod/__TOCDet/DocFragType = ClassMember
EditController/APIMethod/__TOCDet/IsInherited = False
EditController/APIMethod/__TOCDet/IsInheritedDoc = True
EditController/APIMethod/__TOCDet/Name = APIMethod
EditController/APIMethod/__TOCDet/Namespace = ARCAPI
EditController/APIMethod/__TOCDet/Type = EditController
EditController/APIMethod/__TOCDet/Attribute/DeclaringType = BaseController
EditController/APIMethod/__TOCDet/Attribute/Description = The (only) API method that this controller supports.0x000D0x000A0x000D0x000A
EditController/APIMethod/__TOCDet/Attribute/MethodName = APIMethod
EditController/APIMethod/__TOCDet/Attribute/MethodSignature = ARCAPI.ContentResult APIMethod(ARCAPI.ResponseFormat, Int32, System.Collections.Generic.List0x006010x005BARCCore.IKCoded0x005D, System.String, ARCAPI.DataStorage)
EditController/ToString/__TOCDet/Assembly = ARCAPI
EditController/ToString/__TOCDet/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
EditController/ToString/__TOCDet/DocFragType = ClassMember
EditController/ToString/__TOCDet/IsInherited = True
EditController/ToString/__TOCDet/IsInheritedDoc = True
EditController/ToString/__TOCDet/Name = ToString
EditController/ToString/__TOCDet/Namespace = ARCAPI
EditController/ToString/__TOCDet/Type = EditController
EditController/ToString/__TOCDet/Attribute/DeclaringType = PConcurrent
EditController/ToString/__TOCDet/Attribute/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
EditController/ToString/__TOCDet/Attribute/MethodName = ToString
EditController/ToString/__TOCDet/Attribute/MethodSignature = System.String ToString()
GQController/__TOCDet/Assembly = ARCAPI
GQController/__TOCDet/Description = Offers GraphQL queries.0x000D0x000A0x000D0x000ANot implemented as of Dec 2020.0x000D0x000A
GQController/__TOCDet/DocFragType = Class
GQController/__TOCDet/Name = GQController
GQController/__TOCDet/Namespace = ARCAPI
GQController/__TOCDet/Type = GQController
GQController/__TOCDet/Attribute/AssemblyName = ARCAPI
GQController/__TOCDet/Attribute/BaseTypes = PConcurrent0x003BBaseController
GQController/__TOCDet/Attribute/ClassNamespace = ARCAPI
GQController/__TOCDet/Attribute/ClassType = GQController
GQController/__TOCDet/Attribute/Description = Offers GraphQL queries.0x000D0x000A0x000D0x000ANot implemented as of Dec 2020.0x000D0x000A
GQController/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
GQController/APIMethod/__TOCDet/Assembly = ARCAPI
GQController/APIMethod/__TOCDet/Description = The (only) API method that this controller supports.0x000D0x000A0x000D0x000A
GQController/APIMethod/__TOCDet/DocFragType = ClassMember
GQController/APIMethod/__TOCDet/IsInherited = False
GQController/APIMethod/__TOCDet/IsInheritedDoc = True
GQController/APIMethod/__TOCDet/Name = APIMethod
GQController/APIMethod/__TOCDet/Namespace = ARCAPI
GQController/APIMethod/__TOCDet/Type = GQController
GQController/APIMethod/__TOCDet/Attribute/DeclaringType = BaseController
GQController/APIMethod/__TOCDet/Attribute/Description = The (only) API method that this controller supports.0x000D0x000A0x000D0x000A
GQController/APIMethod/__TOCDet/Attribute/MethodName = APIMethod
GQController/APIMethod/__TOCDet/Attribute/MethodSignature = ARCAPI.ContentResult APIMethod(ARCAPI.ResponseFormat, Int32, System.Collections.Generic.List0x006010x005BARCCore.IKCoded0x005D, System.String, ARCAPI.DataStorage)
GQController/ToString/__TOCDet/Assembly = ARCAPI
GQController/ToString/__TOCDet/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
GQController/ToString/__TOCDet/DocFragType = ClassMember
GQController/ToString/__TOCDet/IsInherited = True
GQController/ToString/__TOCDet/IsInheritedDoc = True
GQController/ToString/__TOCDet/Name = ToString
GQController/ToString/__TOCDet/Namespace = ARCAPI
GQController/ToString/__TOCDet/Type = GQController
GQController/ToString/__TOCDet/Attribute/DeclaringType = PConcurrent
GQController/ToString/__TOCDet/Attribute/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
GQController/ToString/__TOCDet/Attribute/MethodName = ToString
GQController/ToString/__TOCDet/Attribute/MethodSignature = System.String ToString()
RQController/__TOCDet/Assembly = ARCAPI
RQController/__TOCDet/Description = RQ = REST Query. Executes a REST like query request against the given -DataStorage-.0x000D0x000AExample: https://yourserver.com/RQ/dt/Customer/42 0x000D0x000A0x000D0x000AThis class understands two main query-methods, 0x000D0x000A1) Direct key-based into data storage, and0x000D0x000A0x000D0x000A2) -QueryExpression- based.0x000D0x000A0x000D0x000AExamples of 1) Direct key-based into data storage queries:0x000D0x000A'Customer/42' =0x003E Get all the keys for Customer with id 42, but do not get sub-keys.0x000D0x000A'Customer/42/*' =0x003E Get all the keys for Customer with id 42, and also all underlying sub-keys (and their sub-keys and so on).0x000D0x000AAppend query with '.json' in order to get -JSON- (default is -HTML-) .0x000D0x000AFor -HTML- this controller is able to do -LinkInsertionInDocumentation-, presumed that -DocLinks- is set.0x000D0x000A0x000D0x000AExamples of 2) -QueryExpression- based queries.0x000D0x000A'Customer/WHERE FirstName = John/SELECT FirstName, LastName/SKIP 10/TAKE 10'0x000D0x000A(see -QueryExpression- for more examples).0x000D0x000A0x000D0x000A
RQController/__TOCDet/DocFragType = Class
RQController/__TOCDet/Name = RQController
RQController/__TOCDet/Namespace = ARCAPI
RQController/__TOCDet/Type = RQController
RQController/__TOCDet/Attribute/AssemblyName = ARCAPI
RQController/__TOCDet/Attribute/BaseTypes = PConcurrent0x003BBaseController
RQController/__TOCDet/Attribute/ClassNamespace = ARCAPI
RQController/__TOCDet/Attribute/ClassType = RQController
RQController/__TOCDet/Attribute/Description = RQ = REST Query. Executes a REST like query request against the given -DataStorage-.0x000D0x000AExample: https://yourserver.com/RQ/dt/Customer/42 0x000D0x000A0x000D0x000AThis class understands two main query-methods, 0x000D0x000A1) Direct key-based into data storage, and0x000D0x000A0x000D0x000A2) -QueryExpression- based.0x000D0x000A0x000D0x000AExamples of 1) Direct key-based into data storage queries:0x000D0x000A'Customer/42' =0x003E Get all the keys for Customer with id 42, but do not get sub-keys.0x000D0x000A'Customer/42/*' =0x003E Get all the keys for Customer with id 42, and also all underlying sub-keys (and their sub-keys and so on).0x000D0x000AAppend query with '.json' in order to get -JSON- (default is -HTML-) .0x000D0x000AFor -HTML- this controller is able to do -LinkInsertionInDocumentation-, presumed that -DocLinks- is set.0x000D0x000A0x000D0x000AExamples of 2) -QueryExpression- based queries.0x000D0x000A'Customer/WHERE FirstName = John/SELECT FirstName, LastName/SKIP 10/TAKE 10'0x000D0x000A(see -QueryExpression- for more examples).0x000D0x000A0x000D0x000A
RQController/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
RQController/APIMethod/__TOCDet/Assembly = ARCAPI
RQController/APIMethod/__TOCDet/Description = The (only) API method that this controller supports.0x000D0x000A0x000D0x000A
RQController/APIMethod/__TOCDet/DocFragType = ClassMember
RQController/APIMethod/__TOCDet/IsInherited = False
RQController/APIMethod/__TOCDet/IsInheritedDoc = True
RQController/APIMethod/__TOCDet/Name = APIMethod
RQController/APIMethod/__TOCDet/Namespace = ARCAPI
RQController/APIMethod/__TOCDet/Type = RQController
RQController/APIMethod/__TOCDet/Attribute/DeclaringType = BaseController
RQController/APIMethod/__TOCDet/Attribute/Description = The (only) API method that this controller supports.0x000D0x000A0x000D0x000A
RQController/APIMethod/__TOCDet/Attribute/MethodName = APIMethod
RQController/APIMethod/__TOCDet/Attribute/MethodSignature = ARCAPI.ContentResult APIMethod(ARCAPI.ResponseFormat, Int32, System.Collections.Generic.List0x006010x005BARCCore.IKCoded0x005D, System.String, ARCAPI.DataStorage)
RQController/ToString/__TOCDet/Assembly = ARCAPI
RQController/ToString/__TOCDet/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
RQController/ToString/__TOCDet/DocFragType = ClassMember
RQController/ToString/__TOCDet/IsInherited = True
RQController/ToString/__TOCDet/IsInheritedDoc = True
RQController/ToString/__TOCDet/Name = ToString
RQController/ToString/__TOCDet/Namespace = ARCAPI
RQController/ToString/__TOCDet/Type = RQController
RQController/ToString/__TOCDet/Attribute/DeclaringType = PConcurrent
RQController/ToString/__TOCDet/Attribute/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
RQController/ToString/__TOCDet/Attribute/MethodName = ToString
RQController/ToString/__TOCDet/Attribute/MethodSignature = System.String ToString()

Edit single sub keys only: __TOCDet / AddController / BaseController / ContentResult / DataStorage / EditController / GQController / RQController

Generated 2024-11-05 04:19:20.763 UTC