Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
ccrz.ccApiPublicCache.toggleGroup
Compatibility
This reference applies to:
Release | Managed Package Version | API Version |
---|---|---|
B2B Commerce for Visualforce Winter ’21 | 4.13 | 12 |
B2B Commerce for Visualforce Spring ’20 | 4.12 | 11 |
B2B Commerce for Visualforce Summer ’19 | 4.11 | 10 |
B2B Commerce for Visualforce Spring ’19 | 4.10 | 9 |
B2B Commerce for Visualforce Summer ’18 | 4.9 | 8 |
Signature
global static Map<String, Object> toggleGroup(Map<String, Object>)
Service Layer Classes
This method doesn't support service layer extensions or overrides.
Inputs (Required)
Map<String, Object> that must include the following required keys:
- ccrz.ccApi.API_VERSION
- The version of the B2B Commerce for Visualforce API to reference for the method call. We recommend that you use the ccrz.ccApi.CURRENT_VERSION constant whenever possible, and only reference a specific version for compatibility if necessary.
- ccrz.ccApiPublicCache.CACHE_NAME
- String that specifies a Cache Name value for the public cache records you want to
update, such as:
- ccCategoryTree for cached page label data that ccrz.ccCategoryCacheBuildJob builds.
- ccPageLabel for cached page label data that ccrz.ccPageLabelCacheBuildJob builds.
ccrz.ccApiPublicCache.CACHE_NAME => 'ccPageLabel'
Inputs (Optional)
The input map can also include the following keys:
- ccrz.ccApiPublicCache.BUILD_GROUP
- String that specifies a Build Group value for the public cache records you want to update. This method updates all public cache records with the same ccrz.ccApiPublicCache.CACHE_NAME and ccrz.ccApiPublicCache.BUILD_GROUP values.
- ccrz.ccApiPublicCache.SET_ENABLED
- Boolean
Value Usage true Enable the Enabled field on each affected public cache record. false Disable the Enabled field on each affected public cache record.
Outputs
None