@salesforce/b2c-tooling-sdk / operations/sites / OcapiSitesBackend

Class: OcapiSitesBackend

Defined in: packages/b2c-tooling-sdk/src/operations/sites/ocapi-sites-backend.ts:30

OCAPI Sites backend (legacy/fallback). Reads sites and per-site detail via the OCAPI Data API /sites resource.

Implements

• SitesBackend

Constructors

Constructor

new OcapiSitesBackend(instance): OcapiSitesBackend

Defined in: packages/b2c-tooling-sdk/src/operations/sites/ocapi-sites-backend.ts:33

Parameters

instance

B2CInstance

Returns

OcapiSitesBackend

Properties

name

readonly name: "ocapi"

Defined in: packages/b2c-tooling-sdk/src/operations/sites/ocapi-sites-backend.ts:31

Implementation of

SitesBackend.name

Methods

addCartridge()

addCartridge(siteId, name, position, target?): Promise<string>

Defined in: packages/b2c-tooling-sdk/src/operations/sites/ocapi-sites-backend.ts:102

Parameters

siteId

string

name

string

position

CartridgePosition

target?

string

Returns

Promise<string>

Implementation of

SitesBackend.addCartridge

---

getCartridgePath()

getCartridgePath(siteId): Promise<string>

Defined in: packages/b2c-tooling-sdk/src/operations/sites/ocapi-sites-backend.ts:82

Parameters

siteId

string

Returns

Promise<string>

Implementation of

SitesBackend.getCartridgePath

---

getSite()

getSite(siteId): Promise<SiteInfo>

Defined in: packages/b2c-tooling-sdk/src/operations/sites/ocapi-sites-backend.ts:72

Parameters

siteId

string

Returns

Promise<SiteInfo>

Implementation of

SitesBackend.getSite

---

listSites()

listSites(options): Promise<SiteInfo[]>

Defined in: packages/b2c-tooling-sdk/src/operations/sites/ocapi-sites-backend.ts:35

Parameters

options

ListSitesOptions = {}

Returns

Promise<SiteInfo[]>

Implementation of

SitesBackend.listSites

---

removeCartridge()

removeCartridge(siteId, name): Promise<string>

Defined in: packages/b2c-tooling-sdk/src/operations/sites/ocapi-sites-backend.ts:118

Parameters

siteId

string

name

string

Returns

Promise<string>

Implementation of

SitesBackend.removeCartridge

---

setCartridgePath()

setCartridgePath(siteId, cartridges): Promise<string>

Defined in: packages/b2c-tooling-sdk/src/operations/sites/ocapi-sites-backend.ts:86

Parameters

siteId

string

cartridges

string

Returns

Promise<string>

Implementation of

SitesBackend.setCartridgePath