For the managed package runtime, this page contains a BaseState LWC ReadMe for each Vlocity release.
This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.
Vlocity Insurance and Health Spring '20
All card states extend BaseState Lightning Web Component as a mixin.
Available baseState Attributes
|
Attribute |
Value |
Type |
Required |
Description |
|---|---|---|---|---|
|
record-id |
string |
Specifies the params id used for the state. |
||
|
theme |
slds, nds (Default: slds) |
string |
Specifies the theme to use. |
|
|
records |
string or array |
Specifies the complete data obj from a layout or card. |
||
|
obj |
string |
Sets the state object. |
||
|
state |
string |
Sets the state definition. |
||
|
selectedState |
true, false (Default: false) |
boolean |
To set as the selected state and make active, set to true. |
|
|
debug |
boolean |
Enables the debug mode. |
||
|
userProfile |
string or object |
Sets the user profile for the component, which is the same user profile for the org. |
Example baseState Component
import { BaseState } from "c/baseState";
export default class CardActiveState extends BaseState(LightningElement) {
// component definition
}
Available Methods
enableEditMode
An API method that sets edit mode to true.
disableEditMode
An API method that sets edit mode to false.
updateObject
Updates a record, and takes the record object as the parameter.
toggleFlyout
Shows or hides the flyout.
handleSmartActions
Reloads the smartActions. It can also be triggerd by pubsub, such as channel: smartActions , name: reload.
Vlocity Insurance and Health Winter '20 and Vlocity CME Spring '20
All card states extend BaseState Lightning Web Component as a mixin.
Available baseState Attributes
|
Attribute |
Value |
Type |
Required |
Description |
|---|---|---|---|---|
|
record-id |
string |
This is the params id used for the state. |
||
|
theme |
slds, nds (Default: slds) |
string |
Specifes the theme to use. |
|
|
records |
string or array |
The complete data obj from layout or card. |
||
|
obj |
string |
Sets the state object. |
||
|
state |
string |
Sets the state definition. |
||
|
selectedState |
boolean |
Is true if this state is the selected state and is active. |
||
|
debug |
boolean |
Enables the debug mode. |
||
|
userProfile |
string or object |
Sets the userprofile for the component, which is the same userprofile for the org. |
||
|
enableEditMode |
method |
Fire this method to enable the edit mode. |
||
|
disableEditMode |
method |
Fire this method to disable the edit mode. |