Contributor API

This is the internal reference for developers contributing changes to the source code for the platform.

The documentation here in the Contributor API is automatically generated: it is extracted directly from source code in the develop branch of the GitHub repository: github.com/insite/code

(Last generated: August 7, 2025)

What you'll find here

This reference documentation includes:

  • Class documentation: All public and protected class definitions
  • Method signatures: Complete method signatures including parameters, return values, and exceptions
  • Property descriptions: All property and field definitions and comments
  • Interface contracts: Full interface definitions with implementation notes from comments
  • Enum values: Enumerations with value descriptions
  • Code examples: Sample code snippets included in comment headers

The search feature at the top allows you to quickly locate specific classes, methods, or members by name.

Use the top navigation bar to browse libraries that target specific frameworks.

Select a target framework and use the table of contents in the left sidebar to browse namespaces and types.

Target frameworks

.NET 9

Projects targeting .NET 9 represent our modern, cross-platform applications and services. These include high-performance web APIs, microservices, console applications, and cloud-native workloads that benefit from the latest runtime optimizations, C# language features, and modern development patterns. .NET 9 projects take advantage of improved performance, enhanced security features, and the unified .NET platform's cross-platform capabilities for Windows, Linux, and macOS deployment.

.NET Standard 2.0

Libraries targeting .NET Standard 2.0 are designed for maximum compatibility across different .NET implementations. These projects are consumed by both .NET Framework and .NET Core applications, serving as a bridge between our legacy and modern codebases. This includes shared business logic, data models, interfaces, and utility libraries that need to work across multiple runtime environments.

.NET Framework 4.8

Projects targeting .NET Framework 4.8 represent our legacy ASP.NET web forms user interface and data access libraries. As a general rule, no new features are implemented in these projects. Instead, all new front-end features are implemented in React, and all new back-end features are implemented in .NET 9.

Documentation standards

All documentation in this reference is generated from XML documentation comments (/// in C#) following standard conventions:

  • <summary> tags provide brief descriptions
  • <param> tags document method parameters
  • <returns> tags describe return values
  • <exception> tags list possible exceptions
  • <example> tags include code samples
  • <remarks> tags contain additional implementation details

Understanding the generated content

Each page in this documentation corresponds to a type or member in the codebase. The documentation quality and completeness depend entirely on the XML comments provided by developers in the source code.

Please remember this is raw contributor API documentation, automatically generated from XML comment headers in the source code using docfx. For conceptual documentation, architecture guides, and other public developer API documentation, please refer to the resources available here: docs.shiftiq.com/developer

Viewing tips

  • Inheritance hierarchy: See base classes and derived types for each class
  • Syntax: View exact method signatures and type declarations
  • Cross-references: Click on type names to navigate to their documentation
  • Namespaces: Browse all types within a namespace from namespace pages