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

Interface: WaitForEnvOptions

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

Options for waiting for an MRT environment to be ready.

Extends

• GetEnvOptions

Properties

onPoll()?

optional onPoll: (info) => void

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

Optional callback invoked on each poll with current status.

Parameters

info

WaitForEnvPollInfo

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

---

pollIntervalSeconds?

optional pollIntervalSeconds: number

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

Polling interval in seconds.

Default

10

---

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

---

sleep()?

optional sleep: (ms) => Promise<void>

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

Custom sleep function for testing.

Parameters

ms

number

Returns

Promise<void>

---

slug

slug: string

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

Environment slug/identifier to retrieve.

Inherited from

GetEnvOptions.slug

---

timeoutSeconds?

optional timeoutSeconds: number

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

Maximum time to wait in seconds (0 for no timeout).

Default

2700 (45 minutes)