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

Interface: SitesBackend

Defined in: packages/b2c-tooling-sdk/src/operations/sites/sites-types.ts:52

Backend contract for site read operations.

Cartridge-path methods model the SCAPI v1.3 custom-cartridges resource and the equivalent OCAPI Data API resource.

Extends

• BackendBase

Properties

name

readonly name: "ocapi" | "scapi"

Defined in: packages/b2c-tooling-sdk/src/clients/scapi-backend-utils.ts:36

Inherited from

BackendBase.name

Methods

addCartridge()

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

Defined in: packages/b2c-tooling-sdk/src/operations/sites/sites-types.ts:57

Parameters

siteId

string

name

string

position

CartridgePosition

target?

string

Returns

Promise<string>

---

getCartridgePath()

getCartridgePath(siteId): Promise<string>

Defined in: packages/b2c-tooling-sdk/src/operations/sites/sites-types.ts:55

Parameters

siteId

string

Returns

Promise<string>

---

getSite()

getSite(siteId): Promise<SiteInfo>

Defined in: packages/b2c-tooling-sdk/src/operations/sites/sites-types.ts:54

Parameters

siteId

string

Returns

Promise<SiteInfo>

---

listSites()

listSites(options?): Promise<SiteInfo[]>

Defined in: packages/b2c-tooling-sdk/src/operations/sites/sites-types.ts:53

Parameters

options?

ListSitesOptions

Returns

Promise<SiteInfo[]>

---

removeCartridge()

removeCartridge(siteId, name): Promise<string>

Defined in: packages/b2c-tooling-sdk/src/operations/sites/sites-types.ts:58

Parameters

siteId

string

name

string

Returns

Promise<string>

---

setCartridgePath()

setCartridgePath(siteId, cartridges): Promise<string>

Defined in: packages/b2c-tooling-sdk/src/operations/sites/sites-types.ts:56

Parameters

siteId

string

cartridges

string

Returns

Promise<string>