@salesforce/b2c-tooling-sdk / operations/mrt / WaitForEnvOptions

Interface: WaitForEnvOptions

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:359

Options for waiting for an MRT environment to be ready.

Extends

• GetEnvOptions

Properties

onPoll()?

optional onPoll: (env) => void

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:375

Optional callback called on each poll with the current environment state.

Parameters

env

Returns

void

---

origin?

optional origin: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:298

MRT API origin URL.

Default

"https://cloud.mobify.com"

Inherited from

GetEnvOptions.origin

---

pollInterval?

optional pollInterval: number

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:364

Polling interval in milliseconds.

Default

10000

---

projectSlug

projectSlug: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:287

The project slug containing the environment.

Inherited from

GetEnvOptions.projectSlug

---

slug

slug: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:292

Environment slug/identifier to retrieve.

Inherited from

GetEnvOptions.slug

---

timeout?

optional timeout: number

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:370

Maximum time to wait in milliseconds.

Default

2700000 (45 minutes)