ccrz.ccApiPublicCache.disableOld

Disables cache records that have the same cache name, storefront, page, and locale as another cache record with a more recent Effective Start date and time. This method changes the value of the Enabled field on the affected public cache records. Make sure that you specify a cache name, storefront, page name, and locale in the method's input map.

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> disableOld(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 the name of cached data to disable, 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.LOCALE
String that specifies a locale to disable old cache entries for. If locale doesn't apply to the cache entries you want to disable, pass an empty string:
ccrz.ccApiPublicCache.LOCALE => ''
ccrz.ccApiPublicCache.PAGENAME
String that specifies a page to disable old cache entries for.
ccrz.ccApiPublicCache.STORE_NAME
String that specifies a storefront to disable old cache entries for.

Outputs

None