rapide_ticket_library library

Classes

AdgentsReportFormAttachmentsScope
Preview data for AdgentsReportFormBuilder (annotated screen capture).
AdgentsReportPayload
Container for the user report (text + capture + metadata).
AdgentsReportScope
A feedback widget that uses a custom widget and data type for prompting the user for their feedback. This widget should be the root of your widget tree. Specifically, it should be above any Navigator widgets, including the navigator provided by MaterialApp.
AdgentsReportSession
Controls the state of the feeback ui.
AdgentsReportSheetGrip
Visual grip for a draggable input sheet.
AdgentsReportStrings
This class must be extended by all custom translations.
AdgentsReportStyle
See the following image to get a better understanding of the properties. Theme
AdgentsReportStyleScope
Provides an instance of AdgentsReportStyle for all descendants.
AdgentsReportTicketFormDraft
Ticket form draft (restored after annotation or a new capture).
ArAdgentsReportStrings
Default arabic localization
AtlassianOAuthLoginStart
Response from GET /api/v1/auth/oauth/atlassian/authorization-url.
BgAdgentsReportStrings
Default bulgarian localization
BnAdgentsReportStrings
Default bangla localization
DeAdgentsReportStrings
Default german localization
ElAdgentsReportStrings
Default greek localization
EnAdgentsReportStrings
Default english localization
EsAdgentsReportStrings
Default spanish localization
FaAdgentsReportStrings
Default persian localization
FrAdgentsReportStrings
Default french localization
GlobalAdgentsReportStringsDelegate
This is a localization delegate, which includes all of the localizations already present in this library.
HeAdgentsReportStrings
Default Henrew localization
IssueCreateResult
JSON response for issue creation (Jira / GitHub sync).
JaAdgentsReportStrings
Default japanese localization
JiraAssignableUser
User returned by GET …/jira/assignable-users (Jira assignable search proxy).
JiraAssignableUsersApi
GET /api/v1/projects/{projectId}/jira/assignable-users
PlAdgentsReportStrings
Default polish localization
PtAdgentsReportStrings
Default portuguese localization
RapideTicket
Package entry points: open the feedback flow + submit issues.
RapideTicketConfigurationError
Shown when RapideTicketSettings.simple cannot be built (e.g. empty projectId).
RapideTicketDioInterceptor
Captures a compact rolling history of Dio calls made by the host app.
RapideTicketHosts
Wraps the app with AdgentsReportScope (built-in capture) and provides RapideTicketInherited (settings + session + HTTP client).
RapideTicketInherited
RapideTicketNativeCapture
Capture d'écran / enregistrement via code natif (iOS + Android).
RapideTicketOAuthReturnListener
Listens to native deep links (AppLinks) and, on the web, the initial URL (Uri.base) to finish OAuth via RapideTicketSession.signInWithOAuthExchangeCode.
RapideTicketOAuthReturnOutcome
Outcome of processing an OAuth return URL (oauth_exchange or oauth_error).
RapideTicketSecretTapScope
Fires the action after requiredTapCount taps within resetDuration.
RapideTicketSession
In-memory JWT session + persisted refresh token; updates the Dio Authorization header.
RapideTicketSettings
SDK settings: API URL (auto-resolved if omitted) and target project.
RuAdgentsReportStrings
Default russian localization
SvAdgentsReportStrings
Default swedish localization
TrAdgentsReportStrings
Default turkish localization
UkAdgentsReportStrings
Default ukrainian localization
ZhAdgentsReportStrings
Default Simplified Chinese localization

Enums

AdgentsReportMode
Available modes of the feedback ui.
AtlassianOAuthSignInOutcome
Result of the Atlassian OAuth flow (JWT sign-in).
IssueSyncStatus
Status returned by POST …/issues (aligned with API).
RapideTicketClientPlatform
Client platform for issues (aligned with Spring API Platform).
RapideTicketSignInMethod
Méthode utilisée lors du dernier sign-in. Sert au formulaire ticket pour décider de la liste à afficher dans le sélecteur d'assignee :

Constants

kIssueTitleMaxLength → const int
kRapideTicketDefaultHostedApiBaseUrl → const String
API host outside debug when no URL dart-define is provided.
kRapideTicketDefaultOAuthPath → const String
OAuth deep link path (often oauth → myscheme://oauth).
kRapideTicketDefaultOAuthScheme → const String
Default OAuth deep link scheme: same value in AndroidManifest / Info.plist. If your app uses another, pass oauthScheme to RapideTicketSettings.simple.
kRapideTicketFeedbackExtraAssigneeAccountId → const String
Jira accountId (multipart jiraAssigneeAccountId on POST …/issues).
kRapideTicketFeedbackExtraAssigneeUserId → const String
UUID utilisateur RapideTicket (multipart assigneeUserId on POST …/issues). Mutuellement exclusif avec kRapideTicketFeedbackExtraAssigneeAccountId — si les deux sont fournis, l'API privilégie assigneeUserId.
kRapideTicketFeedbackExtraDescription → const String
kRapideTicketFeedbackExtraPriority → const String
Priorité du ticket : URGENT / IMPORTANT / NORMAL / LESS_URGENT. Multipart priority sur POST …/issues. Si absent ou vide, l'API applique NORMAL côté serveur.
kRapideTicketFeedbackExtraTitle → const String
Keys for AdgentsReportPayload.extra (form title + description).
kRapideTicketPriorityCodes → const List<String>
Liste fixe des codes de priorité acceptés (ordre haut → bas).
kRapideTicketPriorityImportant → const String
kRapideTicketPriorityLessUrgent → const String
kRapideTicketPriorityNormal → const String
kRapideTicketPriorityUrgent → const String
kRapideTicketSdkDefaultFlavor → const String
API environment field for issues (RapideTicketSettings.simple mode).
kRapideTicketSkipNetworkCaptureExtra → const String
Extra key to skip capture for sensitive or noisy requests.

Functions

clearRapideTicketNetworkHistory() → void
Clears captured network history. Useful in tests or after explicit logout.
completeSessionWithAtlassianOAuth({required BuildContext context, required RapideTicketSession session, String? inviteToken, String? oauthLoginReturnUri, bool allowServerDefaultReturnUri = false, String? projectId, String? mobileOauthSchemeOverride}) → Future<AtlassianOAuthSignInOutcome>
Starts Atlassian OAuth (browser), then obtains a JWT via oauth_exchange or a dialog.
detectRapideTicketClientPlatform({bool? forTestsIsWeb, TargetPlatform? forTestsTarget}) → RapideTicketClientPlatform
Detects the runtime platform (aligned with API Platform enum).
effectiveClientPlatform(RapideTicketSettings settings) → RapideTicketClientPlatform
Effective platform: explicit setting or auto-detection.
enrichIssueDescriptionWithFullMetadata(String userDescription, RapideTicketSettings settings) → Future<String>
Enriches the description with a technical English Markdown block (### headings, - **label:** value list, --- separator). The Jira backend converts this subset to ADF (paragraphs, headings, list, bold).
environmentForApi(RapideTicketSettings settings) → String?
Multipart environment field: flavor first, else RapideTicketSettings.defaultEnvironment.
isNativeOauthDeepLinkReturnUri(String? returnUri) → bool
true if returnUri uses a scheme other than http / https (e.g. myapp://oauth).
issueAssigneeUserIdForApi(AdgentsReportPayload feedback) → String?
Optional RapideTicket assignee user UUID for issue creation. Renvoyé tel quel s'il ressemble à un UUID non-vide, null sinon.
issueDescriptionForApi(AdgentsReportPayload feedback) → String
Description for the API.
issueJiraAssigneeAccountIdForApi(AdgentsReportPayload feedback) → String?
Optional Jira assignee for issue creation.
issuePriorityForApi(AdgentsReportPayload feedback) → String?
Priorité ticket à transmettre à l'API (multipart priority). Retourne l'un de URGENT / IMPORTANT / NORMAL / LESS_URGENT, ou null si l'extra n'est pas fourni — dans ce cas le serveur applique NORMAL. Accepte les variantes casse / LESSURGENT sans underscore.
issueTitleForApi(AdgentsReportPayload feedback) → String
Title for POST …/issues: dedicated field or fallback to legacy single text.
normalizeUserIssueDescription(String userDescription) → String
User-entered text only ; English placeholder if empty.
pushRapideTicketSignInPage(BuildContext context, {required RapideTicketSession session, String? inviteToken}) → Future<bool>
Full-screen sign-in page (JWT). Returns true via Navigator.pop on success.
rapideTicketCaptureScreenPng({ScreenshotController? flutterController, double pixelRatio = 1, Duration delay = const Duration(milliseconds: 20), bool preferNative = true}) → Future<Uint8List>
Capture PNG : natif (WebView inclus) puis repli RepaintBoundary.
rapideTicketIssueFeedbackBuilder(BuildContext context, AdgentsReportFormSubmit onSubmit, ScrollController? scrollController, {Uint8List? videoAttachmentPreviewBytes, Uint8List? companionStaticImagePreviewBytes, VoidCallback? onBackToVideoPreview}) → Widget
Default AdgentsReportFormBuilder: title + description + optional Jira assignee (API-aligned).
rapideTicketNativeSchemeFromSettingsReturnUri(String? oauthLoginReturnUri) → String?
Scheme extracted from oauthLoginReturnUri if it is already a native deep link; else null.
rapideTicketNativeScreenCaptureAvailable() → Future<bool>
Indique si la capture native est disponible sur cette plateforme.
rapideTicketNavigatorContextForOverlay(BuildContext scope) → BuildContext?
Context suited for Navigator.push / RapideTicket.showFeedback: first Navigator.maybeOf, else first NavigatorState in scope's subtree.
showRapideTicketSignInDialog(BuildContext context, {required RapideTicketSession session, String? inviteToken}) → Future<bool>
Simple dialog: Atlassian OAuth or email / password; returns true if sign-in succeeded.

Typedefs

AdgentsReportFormBuilder = Widget Function(BuildContext, AdgentsReportFormSubmit , ScrollController?)
Content of the input panel / sheet.
AdgentsReportFormSubmit = Future<void> Function(String feedback, {List<Uint8List>? additionalVideoAttachments, Map<String, dynamic>? extras, Uint8List? videoAttachment})
Report form submission (text + extras + optional MP4 from the form).
AdgentsReportListener = FutureOr<void> Function(AdgentsReportPayload)
After capture + sending AdgentsReportPayload.
RapideTicketBeginGifRecordingFlow = void Function(BuildContext navigatorAnchorContext)
BuildContext anchor (often the Navigator's) to open sheets / snackbars after GIF.
RapideTicketBeginGifRecordingForTicketForm = void Function(BuildContext navigatorAnchorContext, void onGifReady(Uint8List gifBytes))
GIF recording from the ticket form: GIF is delivered via onGifReady without a second sheet.
RapideTicketOnOAuthReturn = void Function(BuildContext context, RapideTicketOAuthReturnOutcome outcome)
RapideTicketShowScreenCaptureControlSheet = void Function(BuildContext navigatorAnchorContext)
Control sheet after closing the ticket (on-screen annotation).

Exceptions / Errors

RapideTicketApiException