@salesforce/b2c-tooling-sdk / operations/code / OcapiScriptsBackend

Class: OcapiScriptsBackend

Defined in: packages/b2c-tooling-sdk/src/operations/code/ocapi-scripts-backend.ts:32

Backend contract for code-version operations.

Reload is implemented as a backend-agnostic helper (reloadCodeVersion in the operations module) since it's just activate(alternate) + activate(target) on top of these primitives.

Implements

ScriptsBackend

Constructors

Constructor

new OcapiScriptsBackend(instance): OcapiScriptsBackend

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

Parameters

instance

B2CInstance

Returns

OcapiScriptsBackend

Properties

name

readonly name: "ocapi"

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

Implementation of

ScriptsBackend.name

Methods

activateCodeVersion()

activateCodeVersion(codeVersionId): Promise<CodeVersionActivationResult>

Defined in: packages/b2c-tooling-sdk/src/operations/code/ocapi-scripts-backend.ts:47

Parameters

codeVersionId

string

Returns

Promise<CodeVersionActivationResult>

Implementation of

ScriptsBackend.activateCodeVersion

createCodeVersion()

createCodeVersion(codeVersionId): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/code/ocapi-scripts-backend.ts:55

Parameters

codeVersionId

string

Returns

Promise<void>

Implementation of

ScriptsBackend.createCodeVersion

deleteCodeVersion()

deleteCodeVersion(codeVersionId): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/code/ocapi-scripts-backend.ts:51

Parameters

codeVersionId

string

Returns

Promise<void>

Implementation of

ScriptsBackend.deleteCodeVersion

getActiveCodeVersion()

getActiveCodeVersion(): Promise<CodeVersionInfo | undefined>

Defined in: packages/b2c-tooling-sdk/src/operations/code/ocapi-scripts-backend.ts:42

Returns

Promise<CodeVersionInfo | undefined>

Implementation of

ScriptsBackend.getActiveCodeVersion

listCodeVersions()

listCodeVersions(): Promise<CodeVersionInfo[]>

Defined in: packages/b2c-tooling-sdk/src/operations/code/ocapi-scripts-backend.ts:37

Returns

Promise<CodeVersionInfo[]>

Implementation of

ScriptsBackend.listCodeVersions