feedback_github library

Classes

ActivityService: The ActivityService handles communication with activity related methods of the GitHub API.
APIStatus: Model class for the GitHub API status.
APIStatusMessage: Overview class of the GitHub API status.
APIStatusPage
ArFeedbackLocalizations: Default arabic localization
AssigneeEvent: Timeline Assigned and Timeline Unassigned Issue Events
Authentication: Authentication information.
Authorization: Model class for an authorization.
AuthorizationApplication: Model class for an application of an Authorization.
AuthorizationsService: The AuthorizationsService handles communication with authorizations related methods of the GitHub API.
AutoTriggerChecks
BetterFeedback: 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.
BgFeedbackLocalizations: Default bulgarian localization
BnFeedbackLocalizations: Default bangla localization
Branch: Model class for a branch.
CheckRun
CheckRunAction
CheckRunAnnotation
CheckRunAnnotationLevel
CheckRunConclusion
CheckRunFilter
CheckRunImage
CheckRunOutput
CheckRunsService
CheckRunStatus
ChecksService: Contains methods to interact with the Checks API.
CheckSuite: API docs: https://docs.github.com/en/rest/reference/checks#check-suites
CheckSuitesService
CodeSearchItem
CodeSearchResults
Collaborator: The response from listing collaborators on a repo.
CombinedRepositoryStatus: Model class for the combined status of a repository.
CommentEvent: Timeline Comment Event
CommitComment: Model class for a commit comment.
CommitData
CommitDataUser
CommitFile: Model class of a file that was changed in a commit.
CommitInfo
CommitStats: Model class for commit statistics.
CommitUser: Model class for a committer of a commit.
ContentCreation: Model class for the response of a content creation.
Contributor: The response from listing contributors on a repo.
ContributorParticipation: Model class for contributor participation.
ContributorStatistics: Model class for a contributor's statistics for a repository.
ContributorWeekStatistics: Model class to represent the number of additions, deletions and commits a contributor made in a given week.
CreateAuthorization
CreateFile: Model class for a new file to be created.
CreateFork: Model class for a new fork to be created.
CreateGistComment: Model class for a new gist comment to be created.
CreateGitBlob: Model class for a new blob to be created.
CreateGitCommit: Model class for a new commit to be created.
CreateGitTag: Model class for a new tag to be created.
CreateGitTree: Model class for a new tree to be created.
CreateGitTreeEntry: Model class for a new tree entry to be created.
CreateHook: Model class for a new hook to be created.
CreateMerge: Model class for a new merge to be created.
CreateMilestone: Model class for a new milestone to be created.
CreatePublicKey: Model class for a new public key to be created.
CreatePullRequest: Model class for a pull request to be created.
CreatePullRequestComment: Model class for a pull request comment to be created.
CreatePullRequestReview
CreateRelease: Model class for a new release to be created.
CreateReleaseAsset
CreateReleaseNotes
CreateRepository: Model class for a new repository to be created.
CreateStatus: Model class for a new repository status to be created.
CrossReferenceEvent: Timeline Cross Referenced Event
CurrentUser: The Currently Authenticated User
DeFeedbackLocalizations: Default german localization
DismissedReview
DownloadTask: A class which indicates an on-going download task.
ElFeedbackLocalizations: Default greek localization
EnFeedbackLocalizations: Default english localization
EnumWithValue: A Json encodable class that mimics an enum, but with a String value that is used for serialization.
EsFeedbackLocalizations: Default spanish localization
Event: Model class for an event.
EventPoller
ExchangeResponse: Represents a response for exchanging a code for a token.
FaFeedbackLocalizations: Default persian localization
FeedbackController: Controls the state of the feeback ui.
FeedbackLocalizations: This class must be extended by all custom translations.
FeedbackSheetDragHandle: A drag handle to be placed at the top of a draggable feedback sheet.
FeedbackThemeData: See the following image to get a better understanding of the properties.
Firebase: The entry point for accessing Firebase.
FirebaseApp: Represents a single Firebase app instance.
FirebaseOptions: The options used to configure a Firebase app.
FirebaseStorage: The entrypoint for FirebaseStorage.
FrFeedbackLocalizations: Default french localization
FullMetadata: The result of calling getMetadata on a storage object reference.
Gist: Model class for gists.
GistComment: Model class for gist comments.
GistFile: Model class for a gist file.
GistFork: Model class for a gist fork.
GistHistoryEntry: Model class for a gits history entry.
GistsService: The GistsService handles communication with gist methods of the GitHub API.
GitBlob: Model class for a blob.
GitCommit: Model class for a git commit.
GitCommitUser: Model class for an author or committer of a commit. The GitCommitUser may not correspond to a GitHub User.
GitHub: The Main GitHub Client
GitHubApp: GitHub app
GitHubComparison
GitHubFile: Model class for a file on GitHub.
GitHubJson: Internal class for Json encoding that should be used instead of dart:convert.
GitignoreTemplate: Model class for a Gitignore Template.
GitObject: Model class for an object referenced by GitReference and GitTag.
GitReference: Model class for a reference.
GitService: The GitService handles communication with git related methods of the GitHub API.
GitTag: Model class for a tag.
GitTree: Model class for a GitHub tree.
GitTreeEntry: Model class for the contents of a tree structure. GitTreeEntry can represent either a blog, a commit (in the case of a submodule), or another tree.
GlobalFeedbackLocalizationsDelegate: This is a localization delegate, which includes all of the localizations already present in this library.
HeFeedbackLocalizations: Default Henrew localization
Hook: Model class for a repository hook.
HookConfig
HtmlLink
Issue: Model class for an issue on the tracker.
IssueComment: Model class for an issue comment.
IssueLabel: Model class for an issue label.
IssuePullRequest: Model class for a pull request for an issue.
IssueRequest: Model class for a request to create/edit an issue.
IssuesService: The IssuesService handles communication with issues related methods of the GitHub API.
JaFeedbackLocalizations: Default japanese localization
LabelEvent: Labeled and Unlabeled Issue Events
LanguageBreakdown: A Breakdown of the Languages a repository uses.
License: License
LicenseDetails
LicenseKind
Links
ListOptions: The options FirebaseStoragePlatform.list accepts.
ListResult: Class returned as a result of calling a list method (list or listAll) on a Reference.
LockEvent: Locked Issue Event
Milestone: Model class for a milestone.
MilestoneEvent: Milestoned and Demilestoned Issue Event
MiscService: The MiscService handles communication with misc related methods of the GitHub API.
Notification: Model class for notifications.
NotificationSubject: Model class for a notification subject.
NotReadyYet: Marks something as not being ready or complete.
OAuth2Flow: OAuth2 Flow Helper
Octocat
OnlyWhen: Specifies that something should be only used when the specified condition is met.
Organization: Model class for a GitHub organization.
OrganizationMembership: Model class for organization membership.
OrganizationsService: The OrganizationsService handles communication with organization methods of the GitHub API.
Owner
PageBuild
PageBuildError
PageBuildPusher
PaginationHelper: Internal Helper for dealing with GitHub Pagination.
Permissions
PlFeedbackLocalizations: Default polish localization
ProjectCard
ProjectEvent: Added to Project, Moved Columns in Project, Removed from Project, and Converted Note to Issue Issue Events.
PtFeedbackLocalizations: Default portuguese localization
PublicKey: Model class for a public key.
PullRequest: Model class for a Pull Request.
PullRequestComment: Model class for a pull request comment.
PullRequestFile
PullRequestHead: Model class for a Pull Request Head.
PullRequestLink
PullRequestMerge: Model class for a pull request merge.
PullRequestReview
PullRequestReviewComment: Pull Request Review Comment
PullRequestsService: The PullRequestsService handles communication with pull request methods of the GitHub API.
PunchcardEntry: Model Class for a Punchcard Entry
RateLimit: Model class for GitHub Rate Limit Information.
Reaction: This API is currently in preview. It may break.
ReactionRollup
ReactionType
Reference: Represents a reference to a Google Cloud Storage object. Developers can upload, download, and delete objects, as well as get/set object metadata.
Release: Model class for a release.
ReleaseAsset: Model class for a release asset.
ReleaseNotes: Holds release notes information
Rename
RenameEvent: Renamed Issue Event
RepositoriesService: The RepositoriesService handles communication with repository related methods of the GitHub API.
Repository: Model class for a repository.
RepositoryCommit: Model class for a commit in a repository.
RepositoryContents: Model class for a file or directory.
RepositoryCrawler
RepositoryPages: GitHub Pages Information
RepositoryPermissions: Model class for repository permissions.
RepositorySlug: A Repository Slug
RepositoryStatus: Model class for the status of a repository at a particular reference.
RepositorySubscription: Model class for a repository subscription.
ReviewDismissedEvent: Review Dismissed Issue Event
ReviewEvent: Timeline Reviewed Event
ReviewLinks: This is similar to Links but represents a different serialization in the GitHub API.
ReviewRequestEvent: Review Requested and Review Request Removed Issue Events
RuFeedbackLocalizations: Default russian localization
SearchResults<T>
SearchService: The SearchService handles communication with search related methods of the GitHub API.
Service: Superclass for all services.
SettableMetadata: The settable metadata a storage object reference can be set with.
Source
StateChangeIssueEvent: State Change Issue Event
StatusCodes
SvFeedbackLocalizations: Default swedish localization
Tag
Task: A class representing an on-going storage task that additionally delegates to a Future.
TaskSnapshot: A TaskSnapshot is returned as the result or on-going process of a Task.
Team: Model class for a GitHub team.
TeamMember: Model class for a team member.
TeamMembershipState: Model class for the team membership state.
TemplateRepository
TimelineCommitCommentedEvent: Timeline Commit Commented Event
TimelineCommitEvent: Timeline Committed Event
TimelineEvent: Model class for an issue or PR timeline event.
TimelineLineCommentedEvent: Timeline Line Commented Event
Tree
TrFeedbackLocalizations: Default turkish localization
UkFeedbackLocalizations: Default ukrainian localization
UploadTask: A class which indicates an on-going upload task.
UrlShortenerService: The UrlShortenerService provides a handy method to access GitHub's url shortener.
User: Model class for a user.
UserEmail: Model class for a user's email address.
UserFeedback: Container for the feedback of the user.
UserInformation: User Information
UserPlan: A Users GitHub Plan
UsersService: The UsersService handles communication with user related methods of the GitHub API.
Verification
WeeklyChangesCount: Model class for a weekly change count.
YearCommitCountWeek: Model class for a week in a full year commit count.
ZhFeedbackLocalizations: Default Simplified Chinese localization

Enums

FeedbackMode: Available modes of the feedback ui.
MergeMethod
PutStringFormat: The format in which a string can be uploaded to the storage bucket via Reference.putString.
TaskState: Represents the state of an on-going Task.

Extensions

FeedbackGitHub on FeedbackController: extension to call uploadToGitHub

Constants

COMMON_GITHUB_TOKEN_ENV_KEYS → const List<String>
defaultFirebaseAppName → const String: The default Firebase application name.
languageColors → const Map<String, String>
v3ApiMimeType → const String

Properties

githubDateRemoveRegExp → RegExp: final

Functions

buildQueryString(Map<String, dynamic> params) → String
copyOf(dynamic input) → dynamic
createGithubIssue({required String repoUrl, required String title, required String body, required String gitHubToken, List<String> labels = const ['feedback']}) → Future<Issue>: Create issue on the specified repo
createNonNullMap<K, V>(Map<K, V> input, {bool recursive = true}) → Map<K, V?>: Returns a new map containing only the entries of input whose value is not null.
dateToGitHubIso8601(DateTime? date) → String?: Converts the date to GitHub's ISO-8601 format:
findAuthenticationFromEnvironment() → Authentication: Looks for GitHub Authentication information from the current environment.
findAuthenticationInMap(Map map) → Authentication?: Checks the passed in map for keys in COMMON_GITHUB_TOKEN_ENV_KEYS. The first one that exists is used as the github token to call Authentication.withToken with. If the above fails, the GITHUB_USERNAME and GITHUB_PASSWORD keys will be checked. If those keys both exist, then Authentication.basic will be used.
getMappedHost(String originalHost) → String
getResponseDate(Object obj) → DateTime?
getResponseEtag(Object obj) → String?
mapToList(Map input) → List<MapEntry>
parseFancyNumber(String input) → int
parseLinkHeader(String input) → Map<String, String>
putValue(String name, dynamic value, Map<String, dynamic> map) → void: Puts a name and value into the map if value is not null. If value is null, nothing is added.
slugFromAPIUrl(String url) → RepositorySlug
uploadImageToStorage(Uint8List imageData, String filename, Reference? imageRef) → Future<String?>: Upload image to firebase storage and return the download url
uploadToGitHub({required String repoUrl, required String gitHubToken, required String feedbackText, String? title, Uint8List? screenshot, String? filename, List<String> labels = const ['feedback'], bool packageInfo = true, bool deviceInfo = true, String? extraData, Reference? imageRef, bool allowProdEmulatorFeedback = true, int imageDisplayWidth = 300}) → Future<Issue>: Store image in firebase storage and create GitHub issue with feedback

Typedefs

FeedbackBuilder = Widget Function(BuildContext, OnSubmit , ScrollController?): A function that returns a Widget that prompts the user for feedback and calls OnSubmit when the user wants to submit their feedback.
JSONConverter<S, T> = T Function(S input): Creates a Model Object from the JSON input
OnFeedbackCallback = FutureOr<void> Function(UserFeedback): Function which gets called when the user submits his feedback. feedback is the user generated feedback. A string, by default. screenshot is a raw png encoded image. OnFeedbackCallback should cast feedback to the appropriate type.
OnSubmit = Future<void> Function(String feedback, {Map<String, dynamic>? extras}): The function to be called when the user submits his feedback.

Exceptions / Errors

AccessForbidden: Access was forbidden to a resource
BadRequest
FirebaseException: A generic class which provides exceptions in a Firebase-friendly format to users.
GitHubError: Error Generated by GitHub
InvalidJSON
NotAuthenticated: GitHub Client was not authenticated
NotFound: GitHub Entity was not found
NotReady
OrganizationNotFound: GitHub Organization was not found
RateLimitHit: Client hit the rate limit.
ReleaseNotFound: Release not found
RepositoryNotFound: GitHub Repository was not found
ServerError: A GitHub Server Error
TeamNotFound: GitHub Team was not found
UnknownError: An Unknown Error
UserNotFound: GitHub User was not found
ValidationFailed

feedback_github library

Classes

Enums

Extensions

Constants

Properties

Functions

Typedefs

Exceptions / Errors

feedback_github package

feedback_github library