Newer Version Available

This content describes an older version of this product. View Latest

PromptActionOwnerSharingRule

Represents a rule which determines PromptAction sharing access for the owners. Available in API version 46.0 and later.

Use prompts and walkthroughs to display announcements, training, or news to users within the app. Choose to add an action button or link that links to a URL of your choice. Track views, action button clicks, and walkthrough completions.

Supported Calls

create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()

Special Access Rules

Admins have access to add or edit prompts and walkthroughs. For non-admin users, assign the Manage Prompts user permission. Everyone can see the In-App Guidance setup page. To show more than three walkthroughs to users, use the View Walkthroughs user permission, which is part of the Walkthroughs permission set license. The Sales Enablement (myTrailhead) subscription includes this feature. For pricing details, contact your Salesforce account executive. Note the restrictions on user visibility of the walkthroughs you create in the Packaging Prompts and Walkthroughs section.

Fields

Field Details
AccessLevel
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Indicates the access level of users for in-app guidance. Valid values are Read and Edit.
Description
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
Description of the in-app guidance. Maximum of 255 characters.
DeveloperName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization.

When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record.

Note

GroupId
Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the group whose PromptAction are shared.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Name of the in-app guidance.
UserOrGroupID
Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the user or group with whom PromptAction access is shared.