form_gear_engine_sdk library

Classes

ActionInfoJs

Response for action operations (like camera, file upload)

AssignmentConfig

Assignment-specific configuration that can differ per template This allows different templates to have different lookup modes, form modes, and client modes as required by FASIH

AssignmentContext

Assignment-based context that holds template-specific configuration Following FASIH's assignment-based architecture where each assignment can have different lookup modes, form modes, and client modes

AssignmentData

Assignment data containing all form-related information Following FASIH's data structure for assignments

BaseFormDataListener

Convenience base class for FormDataListener implementations

BpsUser

Failure<T>

Represents a failure result with error

FileUploadData

Data model for file upload operations

FileUploadListener

Listener interface for handling file upload operations

FileUploadResult

Result model for file upload operations

FormDataListener

Abstract interface for handling FormGear save/submit operations

FormEngineEntity

FormGear engine entity matching FASIH data structure

FormEngineResponse

Form engine response matching FASIH BaseResponse structure

FormGearApiConfig

API configuration for FormGear SDK endpoints

FormGearConfig

Configuration class for FormGear WebView behavior and official API integration

FormGearGlobalConfig

Global SDK configuration that applies to all assignments This separates global settings (user auth, API endpoints) from assignment-specific settings (lookup mode, form mode, etc.)

FormGearSDK

Main FormGear SDK class - single entry point for all FormGear functionality

GenericInfoJs

Generic response for success/failure operations

JSHandler<T extends JsonCodable>

Base abstract class for JavaScript handlers (following web_view pattern)

JsonCodable

Interface for JSON serializable objects (following web_view pattern)

JsonInfoJs

Response for JSON data (like getTemplate, getPreset)

ListInfoJs

Response for list/array data (like getPrincipalCollection)

Result<T>

A generic result type that represents either success or failure

SaveSubmitData

Data model containing all information for save/submit operations

SaveSubmitResult

Result model for save/submit operations returned by FormDataListener implementations

StringInfoJs

Response for string values (like getUserName)

SubmissionInfoJs

Response for submission operations

Success<T>

Represents a successful result with data

UnifiedFormDataListener

Simple FormDataListener implementation that handles both FormGear and FasihForm using the same logic

VersionCheckResult

Result of version checking operation

Enums

FormEngineType

Enum representing the different types of form engines supported by FASIH

FormGearClientMode

Official FormGear client modes

FormGearFormMode

Official FormGear form modes

FormGearInitialMode

Official FormGear initial modes

FormGearLookupMode

Official FormGear lookup modes

SaveSubmitEngineType

Enum representing which form engine triggered the save/submit operation

VersionState

Represents the different states of form engine version

Extensions

ResultExtension on Result<T>

Extension methods for Result type

SaveSubmitResultExtensions on List<SaveSubmitResult>

Extension methods for working with SaveSubmitResult in collections

Typedefs

JSHandlerCallbackAlias = Future<JsonCodable> Function(List arguments)

Typedef for handler callback function