PromptError
Represents the error or warning associated with the PromptAction.
Prompts and walkthroughs help users discover your products and services, adopt your processes, or learn how to use a new feature. Add prompts and walkthroughs in Lightning Experience pages or apps or in supported Experience Cloud site pages. Add an optional action button or link that goes to a URL. Track views, action button clicks, and walkthrough completions.
Introduced in API version 52.0.
create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
- To add, edit, manage, and view prompts and walkthroughs in Lightning Experience or in Experience Cloud sites, multiple permissions are required. See Permissions for Creating and Accessing In-App Guidance in Salesforce Help.
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Introduced: API version 52.0
- Description: Indicates if the in-app guidance had an error
trueor a warningfalse. The default isfalse. - Default value: false
- Type: string
- Properties: Create, Filter, Group, idLookup, Sort, Update
- Description: Name of the PromptError record.
- Type: reference
- Properties: Create, Filter, Group, Sort, Update
- Description: ID of the PromptAction that the PromptError is related to.
- Relationship name: PromptAction
- Relationship type: relationship
- Refers to: PromptAction
- Type: int
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: Indicates the step number that the user encountered an error or warning in a walkthrough.
- Type: picklist
- Properties: Create, Filter, Group, Restricted picklist, Sort, Update
- Description: Indicates the type of error or warning.
- Possible values:
- NoAccessToApp — NoAccessToApp — A step on this walkthrough is on an app that some of your users don’t have access to.
- NoAccessToPage — NoAccessToPage — A step on the walkthrough is on a page that some of your users don’t have access to.
- ReferenceElementNotFound — ReferenceElementNotFound — The target element has moved or is no longer on your page. Targeted prompts attached to unavailable elements convert to floating prompts. Check your access to the element, or enter targeting mode and reassign the targeted prompt.
- Unavailable — Unavailable — Users tried to open this walkthrough using its URL, but it’s inactive or the users aren’t licensed to see it. To make it accessible to users, check its settings or activate it.
This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.