[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 134 > < TAKE 96 >
96 items
| DocFragId | Assembly | DocFragType | Description.FirstLine() |
|---|---|---|---|
| ARCCore.StreamProcessorP.UnderClosure | ARCCore | EnumMember | Set to TRUE if to be closed, whenever an exception occurs or when class goes out of scope |
| ARCAPI.ContentResult.CreateHTMLOK | ARCAPI | ClassMember | NOTE: Parameter must be a complete HTML page. |
| ARCCore.Extensions.ToStringDateAndTime | ARCCore | ClassMember | Uses format 'yyyy-MM-dd HH:mm:ss.fff'. |
| ARCCore.StreamProcessorP.WriteToConsole | ARCCore | EnumMember | If true then incoming data (from other nodes will be written to console. |
| ARCAPI.ContentResult.CreateError | ARCAPI | ClassMember | TODO: Add a key / value format for error messages, like done for -Log-. |
| ARCCore.Extensions.ToStringWithMS | ARCCore | ClassMember | Uses either format 'd\.hh\:mm\:ss\.fff' or 'hh\:mm\:ss\.fff' depending on TotalHours >=24 hours or not. |
| ARCCore.StreamProcessorP.Timestamp | ARCCore | EnumMember | The timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-. |
| ARCAPI.AddController | ARCAPI | Class | Parses and stores a -PropertyStreamLine-. |
| ARCCore.IKIP | ARCCore | Class | Container class for key (-IK-), and value (-IP-). |
| ARCCore.StreamProcessorP.TimestampIsOld | ARCCore | EnumMember | A warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date. |
| ARCAPI.AddController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCCore.IKIP.AssertTypeIntegrity | ARCCore | ClassMember | See -TryAssertTypeIntegrity- for documentation. |
| ARCCore.StreamProcessorP.TimestampResolution | ARCCore | EnumMember | The time interval between each timestamp update in the -PropertyStream-. |
| ARCAPI.AddController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.IKIP.TryAssertTypeIntegrity | ARCCore | ClassMember | Asserts that value is of correct type as specified by the key. |
| ARCCore.StreamProcessorP.DoNotStoreLocally | ARCCore | EnumMember | For -Client-, incoming data (as received from a -Outgoing-) is possible to store BOTH to disk, AND to (normally) a -PRich-. |
| ARCAPI.AddController.AllowFilter | ARCAPI | ClassMember | Describes what data is allowed to change through a list of -Subscription- instances. |
| ARCCore.IK | ARCCore | Class | IK = Interface Key / Index key. Key used to lookup 'inside' an instance of -IP-. |
| ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocally | ARCCore | EnumMember | Means 'do not store local origin locally but wait until it gets confirmed by core storage'. |
| ARCAPI.BaseController | ARCAPI | Class | Contains basic functionality for serving API methods. |
| ARCCore.IKCoded | ARCCore | Class | Understands coded and unencoded variants of -IK-. |
| ARCCore.StreamProcessorP.CacheDiskWrites | ARCCore | EnumMember | If TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance. |
| ARCAPI.BaseController.BuildControllerStorage | ARCAPI | ClassMember | Builds a collection of 'std' (standard) controller instances to use for serving API requests. |
| ARCCore.IKCoded.EnrichKey | ARCCore | ClassMember | 'Implementing' -ITypeDescriber-. |
| ARCCore.StreamProcessorP.CopyFileStructureFromCore | ARCCore | EnumMember | If TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-). |
| ARCAPI.BaseController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCCore.IKCoded.TryCheckValidEncodedValue | ARCCore | ClassMember | Checks if encoded value is valid. |
| ARCCore.StreamProcessorP.CountIncomingConnections | ARCCore | EnumMember | |
| ARCAPI.BaseController.CatchAll | ARCAPI | ClassMember | Serves the typical single generic API method in an AgoRapide API. |
| ARCCore.IKCoded.FromCacheEncoded | ARCCore | ClassMember | Reduces number of objects generated by caching those known to be within a limited range |
| ARCCore.StreamProcessorP.CountOutgoingConnections | ARCCore | EnumMember | |
| ARCAPI.BaseController.TryNavigateToLevelInDataStorage | ARCAPI | ClassMember | Navigates to the specified level (usually within -Storage-). |
| ARCCore.IKCoded.FromCacheUnencoded | ARCCore | ClassMember | Reduces number of objects generated by caching those known to be within a limited range |
| ARCCore.StreamProcessorP.CountOutsideLocalReceiver | ARCCore | EnumMember | Count of calls to -OutsideLocalReceiver-. |
| ARCAPI.BaseController.GetFormatAndAdjustRequest | ARCAPI | ClassMember | Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on). |
| ARCCore.IKCoded.FromEncoded | ARCCore | ClassMember | Note how uses instance cache if already exists there. |
| ARCCore.StreamProcessorP.CountReceiveLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- with -HasLocalOrigin-. |
| ARCAPI.BaseController.GetTimestampIsOldWarningHTML | ARCAPI | ClassMember | If -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format. |
| ARCCore.IKCoded.TryEncode | ARCCore | ClassMember | Returns a string containing only characters in -AllowedEncodedCharacters-. |
| ARCCore.StreamProcessorP.CountReceiveNonLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- not with -HasLocalOrigin-. |
| ARCAPI.BaseController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.IKCoded.ToString | ARCCore | ClassMember | Returns -Encoded-'s string representation. |
| ARCCore.StorageFileP | ARCCore | Enum | Describes class -StorageFile-. |
| ARCAPI.EditController | ARCAPI | Class | Offers a simple HTML editing environment of the raw -PropertyStream- from the given key. |
| ARCCore.IKCoded.Encoded | ARCCore | ClassMember | This string value can be used directly in folder names, file names and HTTP URL's without any further encoding being necessary. |
| ARCCore.StorageFileP.Filename | ARCCore | EnumMember | |
| ARCAPI.EditController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCCore.IKCoded.AllowedEncodedCharacters | ARCCore | ClassMember | The character set 'A...Za...z0...9-_().,='. |
| ARCCore.StorageFileP.Hash | ARCCore | EnumMember | Hash of storage file. Not implemented as of Apr 2020. It is envisaged to store hash-value as last line in storage file. In this case the hash must be the hash of the file excluding the last line |
| ARCAPI.EditController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.IKDate | ARCCore | Class | A more memory efficient alternative to -IKString- (together with -IKLong-). |
| ARCCore.ConnectionDirection | ARCCore | Enum | The concept of who took the initiative for the connections (who asked to open the TCP/IP session). |
| ARCAPI.GQController | ARCAPI | Class | Offers GraphQL queries. |
| ARCCore.IKDate.op_Equality | ARCCore | ClassMember | It is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here. |
| ARCCore.ConnectionDirection.Incoming | ARCCore | EnumMember | ConnectionInstruction will not be set for these. |
| ARCAPI.GQController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCCore.IKDate.EnrichKey | ARCCore | ClassMember | 'Implementing' -ITypeDescriber-. |
| ARCCore.ConnectionDirection.Outgoing | ARCCore | EnumMember | There would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-: |
| ARCAPI.GQController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.IKDate.ValidDateTimeFormats | ARCCore | ClassMember | Note: Be very careful about expanding this array. ToString must be considered, and also how Equals should work with other sub classes of IK. |
| ARCCore.DataTransferDirection | ARCCore | Enum | Direction for transfer of data. |
| ARCAPI.RQController | ARCAPI | Class | RQ = REST Query. Executes a REST like query request against the given -DataStorage-. |
| ARCCore.IKLong | ARCCore | Class | A more memory efficient alternative to -IKString-. |
| ARCCore.DataTransferDirection.Send | ARCCore | EnumMember | Like -Client- sending in-application generated properties to -ArmDB- / -CoreDB- or -ArmDB- sending data received over an incoming connection to -CoreDB-. |
| ARCAPI.RQController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCCore.IKLong.op_Equality | ARCCore | ClassMember | It is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here. |
| ARCCore.DataTransferDirection.Receive | ARCCore | EnumMember | Like -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-. |
| ARCAPI.RQController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.IKLong.EnrichKey | ARCCore | ClassMember | 'Implementing' -ITypeDescriber-. |
| ARCCore.TPropertyKeyEnum | ARCCore | Enum | Placeholder for any enum type suitable as generic type parameter for -PExact-. |
| ARCAPI.DataStorage | ARCAPI | Class | The all-in-memory global application data storage. |
| ARCCore.IKString | ARCCore | Class | Index key for any general id, like primary-key or sequence-number or similar. |
| Assembly ARCDoc | Assembly | A library supporting documentation and demonstrating usage of AgoRapide. | |
| ARCAPI.DataStorage.Create | ARCAPI | ClassMember | Creates a -DataStorage- instance with default parameters. |
| ARCCore.IKString.FromCache | ARCCore | ClassMember | Reduces number of objects generated by caching those known to be within a limited range |
| ARCDoc.Apple | ARCDoc | Class | The most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-. |
| ARCAPI.DataStorage..ctor | ARCAPI | ClassMember | This method will: |
| ARCCore.IKString.FromString | ARCCore | ClassMember | Note how uses instance cache if already exists there |
| ARCDoc.Apple.AddName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCAPI.DataStorage.Storage | ARCAPI | ClassMember | The actual storage. |
| ARCCore.IKString.op_Equality | ARCCore | ClassMember | It is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here. |
| ARCDoc.Apple.GetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCAPI.DataStorage.ControllerStorage | ARCAPI | ClassMember | Usually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]). |
| ARCCore.IKString.EnrichKey | ARCCore | ClassMember | 'Implementing' -ITypeDescriber-. |
| ARCDoc.Apple.TryGetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCAPI.DataStorage.DocLinks | ARCAPI | ClassMember | Note that may be null. |
| ARCCore.IKType | ARCCore | Class | Index key used when storing a collection of a given type, like 'Customer'. |
| ARCDoc.Apple.TryGetP | ARCDoc | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
| ARCAPI.DataStorage.Lock | ARCAPI | ClassMember | Locking object for thread-safe access from simultaneous API requests. |
| ARCCore.IKType.ToString | ARCCore | ClassMember | Caching is supposed to be useful because may be called quite often. |
| ARCDoc.Apple.TryGetV | ARCDoc | 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.DataStorage.ExternalReceiver | ARCAPI | ClassMember | Typically used by -AddController-. |
| ARCCore.ITypeDescriber | ARCCore | Class | Provides a standardized mechanism for describing single-property values (like 'PhoneNumber' of 'Customer' for instance). |
| ARCDoc.Apple.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCAPI.DataStorage.DoNotStoreInternally | ARCAPI | ClassMember | Typically used by -AddController-. |
| ARCCore.ITypeDescriber.GetSyntaxHelp | ARCCore | ClassMember | Enables explanation of syntax in different contexts from one source: |
Generated 2025-07-11 11:27:16.657 UTC