ccrz.ccApiPrivateCache.fetch

Compatibility

This reference applies to:

Signature

global static Map<String, Object> fetch(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.ccApiPrivateCache.CACHE_NAME

String that specifies a Cache Name for the private cache records to query, such as ccConfig.

ccrz.ccApiPrivateCache.CACHE_NAME => 'ccConfig'

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

Note

Inputs (Optional)

The input map can also include the following keys:

ccrz.ccApiPrivateCache.LOCALE

String that specifies a locale to filter the queried cached data by.

If cached data isn't available for the specified locale, the method falls back to query other locales with the same language component. For example, maybe you specify en_US but cached data isn't available for that locale. The method then queries for cached data from any locale that starts with en, such as en_GB or en_AU.

Note

ccrz.ccApiPrivateCache.PAGENAME

String that specifies the name of a page whose cached data you want to query. Use the page keys defined in CC Admin global settings, such as hp for Home page and plp for Product List page.

ccrz.ccApiPrivateCache.PAGENAME => 'hp'

To query cached data from all pages, specify All. If you don't include this key in your input map, the method uses All by default.

ccrz.ccApiPrivateCache.PAGENAME => 'All'

ccrz.ccApiPrivateCache.STORE_NAME

String that specifies a storefront whose cached data you want to query.

ccrz.ccApiPrivateCache.STORE_NAME => 'DefaultStore'

To query cached data from all storefronts, specify Global. If you don't include this key in your input map, the method uses Global by default.

ccrz.ccApiPrivateCache.STORE_NAME => 'Global'

Fallback Behavior

Depending on which values you include in the input map, this method incrementally falls back to a less specific query, in the following order of priority.

Outputs

Map<String, Object> that can include the following keys:

ccrz.ccApi.API_VERSION

Integer that indicates which API version was used for the query.

ccrz.ccApi.SUCCESS

Boolean

Value	Usage
true	The call completed.
false	The call encountered errors. B2B Commerce for Visualforce doesn't always return an exception for any errors that can occur. When this value is false, consider rolling back the API transaction to a previous savepoint. Tip

ccrz.ccApiPrivateCache.CONTENT

String of the cached data that matches the query.