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

Changes the value of the Enabled field for all public cache records that belong to the same build group.

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

You can still call older versions of the API for this method, which can accept different input keys or return different output keys. Any differences in behavior for older versions aren't documented in this topic.

Note

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.

If this key isn't specified, the method returns a ccrz.ccApi.NoApiVersionException.

Note

ccrz.ccApiPublicCache.CACHE_NAME
String that specifies a Cache Name value for the public cache records you want to update, such as:
ccrz.ccApiPublicCache.CACHE_NAME => 'ccPageLabel'

If this key isn't specified, the method returns a ccrz.ccApiPublicCache.NoCacheNameException.

Note

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.

If you don't include this key, by default this method changes the current value of the Enabled field to the opposite value. For example, if Enabled is true, this method changes Enabled to false.

Note

Outputs

None