SuggestionProto

import type { SuggestionProto } from "https://googleapis.deno.dev/v1/toolresults:v1beta3.ts";

interface SuggestionProto {

helpUrl?: string;

longMessage?: SafeHtmlProto;

priority?:

| "unknownPriority"

| "error"

| "warning"

| "info";

pseudoResourceId?: string;

region?: RegionProto;

resourceName?: string;

screenId?: string;

secondaryPriority?: number;

shortMessage?: SafeHtmlProto;

title?: string;

}

§Properties

helpUrl?: string

[src]

Reference to a help center article concerning this type of suggestion. Always set.

longMessage?: SafeHtmlProto

[src]

Message, in the user's language, explaining the suggestion, which may contain markup. Always set.

priority?: "unknownPriority" | "error" | "warning" | "info"

[src]

Relative importance of a suggestion. Always set.

pseudoResourceId?: string

[src]

A somewhat human readable identifier of the source view, if it does not have a resource_name. This is a path within the accessibility hierarchy, an element with resource name; similar to an XPath.

region?: RegionProto

[src]

Region within the screenshot that is relevant to this suggestion. Optional.

resourceName?: string

[src]

Reference to a view element, identified by its resource name, if it has one.

screenId?: string

[src]

ID of the screen for the suggestion. It is used for getting the corresponding screenshot path. For example, screen_id "1" corresponds to "1.png" file in GCS. Always set.

secondaryPriority?: number

[src]

Relative importance of a suggestion as compared with other suggestions that have the same priority and category. This is a meaningless value that can be used to order suggestions that are in the same category and have the same priority. The larger values have higher priority (i.e., are more important). Optional.

shortMessage?: SafeHtmlProto

[src]

Concise message, in the user's language, representing the suggestion, which may contain markup. Always set.

title?: string

[src]

General title for the suggestion, in the user's language, without markup. Always set.