package dart_services.api

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: AnalysisResults

string kind = 1
int32 line = 2
string message = 3
string sourceName = 4
bool hasFixes = 5
int32 charStart = 6
int32 charLength = 7
string url = 8
repeated DiagnosticMessage diagnosticMessages = 9
string correction = 10

repeated AnalysisIssue issues = 1
repeated string packageImports = 2
The package imports parsed from the source.
optional ErrorMessage error = 99
Make this response compatible with BadRequest

Used in: CommonApiCallRequest, GetApiCallResponse

string name = 1
string method = 2
string url = 3
repeated ApiCallParamsInfo params = 4

Used in: ApiCallInfo

string key = 1
string type = 2
string value = 3

The response from the `/assists` service call.

repeated CandidateFix assists = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

Response from the server when errors are thrown internally

optional ErrorMessage error = 99

Represents a possible way of solving an Analysis Problem.

Used in: AssistsResponse, ProblemAndFixes

string message = 1
repeated SourceEdit edits = 2
int32 selectionOffset = 3
repeated LinkedEditGroup linkedEditGroups = 4

string type = 1
string name = 2
string version = 3
string userId = 4
string projectName = 5

string result = 1
optional ErrorMessage error = 99

optional ApiCallInfo api = 1

string result = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

(message has no fields)

string result = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

string source = 1
The Dart source.
string pageName = 2
string type = 3
The source type.
string runMode = 4
The run mode.

string result = 1
string modulesBaseUrl = 2
optional ErrorMessage error = 99
Make this response compatible with BadRequest

string source = 1
The Dart source.
bool returnSourceMap = 2
Return the Dart to JS source map; optional (defaults to false).

string result = 1
string sourceMap = 2
optional ErrorMessage error = 99
Make this response compatible with BadRequest

int32 replacementOffset = 1
The offset of the start of the text to be replaced.
int32 replacementLength = 2
The length of the text to be replaced.
repeated Completion completions = 3
optional ErrorMessage error = 99
Make this response compatible with BadRequest

Used in: CompleteResponse

map<string, string> completion = 1

Used in: GetComponentListResponse

string componentName = 1
string componentId = 2
string categoryType = 3
string type = 4
string content = 5
repeated string dependencies = 6

string dir = 1
string path = 2

string projectName = 1
string userId = 2
string name = 3
string desc = 4
string content = 5
string editType = 7

int32 status = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

string projectName = 1
string userId = 2
string name = 3
string desc = 4
string content = 5
repeated int32 screenshots = 6
string editType = 7

int32 status = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

string pagePath = 1
string pageName = 2

string result = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

string userId = 1
string projectName = 2
string templateProject = 3

string result = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

string pagePath = 1
string pageName = 2
string templatePage = 3

string result = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

Used in: GetCustomActionsResponse

string name = 1
string desc = 2
string path = 3

Used in: GetCustomComponentsResponse

string name = 1
string desc = 2
string path = 3
string fairWidgetCode = 4
string screenshot = 5

string projectName = 1
string userId = 2
string name = 3
string path = 4
string type = 5

string result = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

string projectName = 1
string pageName = 2
string userId = 3

string result = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

string userId = 1
string projectName = 2

string result = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

string userId = 1
string projectName = 2

string filePath = 1
optional ErrorMessage error = 99

Used in: AnalysisIssue

string message = 1
int32 line = 2
int32 charStart = 3
int32 charLength = 4

string userId = 1
string projectName = 2

string result = 1
optional ErrorMessage error = 99

map<string, string> info = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

Individual error messages.

Used in: AnalysisResults, AssistsResponse, BadRequest, ChangeDependencyResponse, CommonApiCallResponse, CommonResponse, CompileDDCResponse, CompileResponse, CompleteResponse, CreateCustomActionResponse, CreateCustomComponentResponse, CreateProjectPageResponse, CreateProjectResponse, CreateTemplatePageResponse, DeleteCustomCodeItemResponse, DeleteProjectPageResponse, DeleteProjectResponse, DependencyPathResponse, DoPubGetResponse, DocumentResponse, ExportProjectResponse, FairCompileResponse, FairRunResponse, FixesResponse, FormatResponse, GetApiCallResponse, GetComponentListResponse, GetCustomActionsResponse, GetCustomComponentsResponse, GetFairDslListResponse, GetFairDslResponse, GetPageResponse, GetProjectPagesResponse, GetProjectResponse, GetQrCodeResponse, GetTemplatePagesResponse, UploadPluginResponse, VersionResponse

string message = 1

string result = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

string json = 1
string js = 2
optional ErrorMessage error = 99
Make this response compatible with BadRequest

Used in: GetFairDslListResponse

string jsonPath = 1
string jsPath = 2

string result = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

Used in: ProjectPageInfo

string name = 1
string path = 2

repeated ProblemAndFixes fixes = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

Represents a reformatting of the code.

string newString = 1
The formatted source code.
int32 offset = 2
The (optional) new offset of the cursor; can be `null`.
optional ErrorMessage error = 99
Make this response compatible with BadRequest

repeated ApiCallInfo api = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

string projectName = 1
string projectId = 2
string categoryType = 3

string projectName = 1
string projectId = 2
string categoryType = 3
repeated ComponentItemInfo componentItems = 4
optional ErrorMessage error = 99

string projectName = 1
string userId = 2

repeated CustomActionInfo result = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

string projectName = 1
string userId = 2

repeated CustomComponentInfo result = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

repeated FairDslInfo result = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

string pageName = 1
string jsonPath = 2
string jsPath = 3

string json = 1
string js = 2
optional ErrorMessage error = 99
Make this response compatible with BadRequest

string pagePath = 1

string result = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

string userId = 1
string projectName = 2

repeated ProjectPageInfo result = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

string userId = 1

repeated ProjectInfo result = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

string result = 1
optional ErrorMessage error = 99

string userId = 1
string projectName = 2

repeated TemplatePageInfo result = 1
optional ErrorMessage error = 99
Make this response compatible with BadRequest

Used in: CandidateFix

repeated int32 positions = 1
The positions of the regions that should be edited simultaneously.
int32 length = 2
The length of the regions that should be edited simultaneously.
repeated LinkedEditSuggestion suggestions = 3
Pre-computed suggestions for what every region might want to be changed to.

Used in: LinkedEditGroup

string value = 1
The value that could be used to replace all of the linked edit regions.
string kind = 2
The kind of value being proposed.

Used in: VersionResponse

string name = 1
The name of this package.
string version = 2
The selected version of this package.
bool supported = 3
Whether this package is supported as a directly importable package, or simply available as a transitive dependency of a supported package.

Represents a problem detected during analysis, and a set of possible ways of resolving the problem.

Used in: FixesResponse

repeated CandidateFix fixes = 1
string problemMessage = 2
int32 offset = 3
int32 length = 4

Used in: GetProjectResponse

string name = 1
string modifiedTime = 2
string desc = 3
string screenshot = 4

Used in: GetProjectPagesResponse

string dir = 1
repeated FileInfo files = 2

Represents a single edit-point change to a source file.

Used in: CandidateFix

int32 offset = 1
int32 length = 2
string replacement = 3

string source = 1
The Dart source.
int32 offset = 2
The offset within source to operate at.
string filePath = 3
The Dart file path
string type = 4
The source type.

Used in: GetTemplatePagesResponse

string pageName = 1
string pagePath = 2
string screenshot = 3

string appId = 1
string bundleName = 2
string patchUrl = 3

string result = 1
optional ErrorMessage error = 99

(message has no fields)

The response from the `/version` service call.

string sdkVersion = 1
The Dart SDK version that DartServices is compatible with.
string sdkVersionFull = 2
The full Dart SDK version that DartServices is compatible with.
string runtimeVersion = 3
The Dart SDK version that the server is running on. This will start with a semver string, and have a space and other build details appended.
string appEngineVersion = 4
The App Engine version.
string servicesVersion = 5
The dart-services backend version.
string flutterVersion = 6
The Flutter SDK's version.
string flutterDartVersion = 7
The Flutter SDK's Dart version.
string flutterDartVersionFull = 8
The Flutter SDK's full Dart version.
map<string, string> packageVersions = 9
Package version numbers. Each package found in pubspec.lock is included, mapping the package name to the package version. Deprecated: Use `packageInfo` data if available.
repeated PackageInfo packageInfo = 10
Package information. Each package found in `pubspec.lock` is included.
optional ErrorMessage error = 99
Make this response compatible with BadRequest

package dart_services.api

message AnalysisIssue

string kind = 1

int32 line = 2

string message = 3

string sourceName = 4

bool hasFixes = 5

int32 charStart = 6

int32 charLength = 7

string url = 8

repeated DiagnosticMessage diagnosticMessages = 9

string correction = 10

message AnalysisResults

repeated AnalysisIssue issues = 1

repeated string packageImports = 2

optional ErrorMessage error = 99

message ApiCallInfo

string name = 1

string method = 2

string url = 3

repeated ApiCallParamsInfo params = 4

message ApiCallParamsInfo

string key = 1

string type = 2

string value = 3

message AssistsResponse

repeated CandidateFix assists = 1

optional ErrorMessage error = 99

message BadRequest

optional ErrorMessage error = 99

message CandidateFix

string message = 1

repeated SourceEdit edits = 2

int32 selectionOffset = 3

repeated LinkedEditGroup linkedEditGroups = 4

message ChangeDependencyRequest

string type = 1

string name = 2

string version = 3

string userId = 4

string projectName = 5

message ChangeDependencyResponse

string result = 1

optional ErrorMessage error = 99

message CommonApiCallRequest

optional ApiCallInfo api = 1

message CommonApiCallResponse

string result = 1

optional ErrorMessage error = 99

message CommonRequest

message CommonResponse

string result = 1

optional ErrorMessage error = 99

message CompileDDCRequest

string source = 1

string pageName = 2

string type = 3

string runMode = 4

message CompileDDCResponse

string result = 1

string modulesBaseUrl = 2

optional ErrorMessage error = 99

message CompileRequest

string source = 1

bool returnSourceMap = 2

message CompileResponse

string result = 1

string sourceMap = 2

optional ErrorMessage error = 99

message CompleteResponse

int32 replacementOffset = 1

int32 replacementLength = 2

repeated Completion completions = 3

optional ErrorMessage error = 99

message Completion

map<string, string> completion = 1

message ComponentItemInfo

string componentName = 1

string componentId = 2

string categoryType = 3