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

Class: ScapiSitesBackend

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

SCAPI Sites backend. Reads sites and manages custom cartridge paths via the site/sites/v1 Admin API.

Implements

• SitesBackend

Constructors

Constructor

new ScapiSitesBackend(config): ScapiSitesBackend

Defined in: packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts:60

Parameters

config

ScapiSitesBackendConfig

Returns

ScapiSitesBackend

Properties

name

readonly name: "scapi"

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

Implementation of

SitesBackend.name

Methods

addCartridge()

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

Defined in: packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts:178

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/scapi-sites-backend.ts:149

Parameters

siteId

string

Returns

Promise<string>

Implementation of

SitesBackend.getCartridgePath

---

getSite()

getSite(siteId): Promise<SiteInfo>

Defined in: packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts:138

Parameters

siteId

string

Returns

Promise<SiteInfo>

Implementation of

SitesBackend.getSite

---

listSites()

listSites(options): Promise<SiteInfo[]>

Defined in: packages/b2c-tooling-sdk/src/operations/sites/scapi-sites-backend.ts:66

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/scapi-sites-backend.ts:188

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/scapi-sites-backend.ts:163

Parameters

siteId

string

cartridges

string

Returns

Promise<string>

Implementation of

SitesBackend.setCartridgePath