encatch_flutter library
Encatch Flutter SDK
Import this file to access all public SDK APIs:
import 'package:encatch_flutter/encatch_flutter.dart';
Classes
- AddressAnswer
- Answer for an address question.
- AnnotationAnswer
- Answer data for an annotation/drawing question type.
- AnnotationMarker
- A single timestamped annotation marker on a video/audio annotation question.
- ApiDeviceInfo
- Device and environment metadata attached to every API request.
- BuildSubmitRequestOptions
- Options used when constructing a SubmitFormRequest via buildSubmitRequest.
- Encatch
- The Encatch SDK singleton.
- EncatchConfig
- Configuration options for the Encatch SDK.
- EncatchInlineForm
- Add to MaterialApp.navigatorObservers for automatic screen tracking.
- EncatchProvider
- Top-level widget that initializes the Encatch Flutter SDK.
- EncatchWebView
-
Headless widget that listens for Encatch.onShowForm / Encatch.onDismissForm
and renders the Encatch survey/feedback form as a full-screen overlay using
flutter_inappwebview. - EventPayload
- Payload delivered to EventCallback listeners on every SDK event.
- FileUploadAnswerItem
- A single uploaded file in a file-upload answer.
- FormDetails
- Details of a form submission, including responses and metadata.
- IdentifyOptions
- Additional options passed to Encatch.identifyUser.
- IdentifyUserResponse
- Response from the identify-user API endpoint.
- NativeFormResponse
- A single question response from a custom native form.
- PaymentsUpiAnswer
- Answer for a UPI payments question.
- PhoneNumberAnswer
- Answer for a phone-number question, including country code and E.164 form.
- Preferences
- Persisted user preferences (locale and country).
- QnaWithAiConversationTurn
- A single turn in the conversation history sent to the qna-with-ai endpoint.
- QnaWithAiPair
- A single Q&A exchange in a QuestionType.qnaWithAi answer.
- QnaWithAiRequest
- Request payload for the Q&A-with-AI API (Encatch.streamQnaWithAi).
- QnaWithAiResponse
- Response returned by the Q&A-with-AI API (Encatch.streamQnaWithAi).
- QuestionAnswer
- The answer values for a single form question.
- QuestionResponse
- A single question's ID, type, and answer in a form submission.
- RefineTextRequest
- Request payload for the AI text refinement endpoint.
- RefineTextResponse
- Response from the AI text refinement endpoint.
- SchedulerAnswer
- Answer for a scheduler question (Google Calendar or Calendly booking).
- SecureOptions
- HMAC options for secure user identification.
- ShowFormInterceptorPayload
- Payload passed to EncatchConfig.onBeforeShowForm.
- ShowFormOptions
- Options for controlling form display behavior.
- ShowFormRequest
- Request payload for the show-form API endpoint.
- ShowFormResponse
- Response from the show-form API endpoint, containing form configuration.
- SignatureAnswer
- Answer for a signature question (typed name, drawn, or uploaded).
- StartSessionOptions
- Options for controlling SDK session start behavior.
- SubmitFormRequest
- Request payload for submitting a completed form.
- UploadFileRequest
- Parameters for Encatch.uploadFile.
- UploadFileResponse
- Response returned by Encatch.uploadFile.
- UserTraits
- Describes changes to apply to a user's trait profile.
- VideoAudioAnswer
- Answer for a video/audio/photo/text capture question.
Enums
- EncatchTheme
- The color theme to use when rendering forms.
- EventType
- Events emitted by the SDK during the form lifecycle.
- FormMessageType
- Message types sent from the WebView form to the native SDK.
- FormPresentation
- Resolved presentation target for a showForm call.
- QuestionType
- All supported question types in a form.
- ResetMode
- Controls when the form response data is reset between form displays.
- SdkMessageType
- Message types sent from the native SDK to the WebView form.
- TriggerType
- How a form display was triggered.
Extensions
- FormMessageTypeExt on FormMessageType
- Extension on FormMessageType for string serialization/deserialization.
- QuestionTypeExt on QuestionType
- Extension on QuestionType for wire-format string serialization.
- SdkMessageTypeExt on SdkMessageType
- Extension on SdkMessageType for wire-format string serialization.
Functions
-
buildSubmitRequest(
{required BuildSubmitRequestOptions options, required List< NativeFormResponse> responses}) → SubmitFormRequest - Builds a SubmitFormRequest from native form responses.
Typedefs
- EventCallback = void Function(EventType eventType, EventPayload payload)
- Callback signature for SDK lifecycle events.
- NativeFormValue = dynamic
- A valid native form answer value.