cap-nodejs

CAP Node.js API

---

CAP Node.js API / cap-dashboard-core/src / CapDashboardCoreService

Class: CapDashboardCoreService

Defined in: cap-dashboard-core/src/dashboard.service.ts:56

Constructors

Constructor

new CapDashboardCoreService(options): CapDashboardCoreService

Defined in: cap-dashboard-core/src/dashboard.service.ts:65

Parameters

options

CapDashboardCoreServiceOptions

Returns

CapDashboardCoreService

Methods

flushOutbox()

flushOutbox(): Promise<ActionResultDto>

Defined in: cap-dashboard-core/src/dashboard.service.ts:233

Returns

Promise<ActionResultDto>

---

getInboxById()

getInboxById(id, full?): Promise<InboxItemDto | undefined>

Defined in: cap-dashboard-core/src/dashboard.service.ts:185

Parameters

id

string

full?

boolean = false

Returns

Promise<InboxItemDto | undefined>

---

getOutboxById()

getOutboxById(id, full?): Promise<OutboxItemDto | undefined>

Defined in: cap-dashboard-core/src/dashboard.service.ts:103

Parameters

id

string

full?

boolean = false

Returns

Promise<OutboxItemDto | undefined>

---

listInbox()

listInbox(query): Promise<InboxPageDto>

Defined in: cap-dashboard-core/src/dashboard.service.ts:158

Parameters

query

ListQueryDto

Returns

Promise<InboxPageDto>

---

listOutbox()

listOutbox(query): Promise<OutboxPageDto>

Defined in: cap-dashboard-core/src/dashboard.service.ts:75

Parameters

query

ListQueryDto

Returns

Promise<OutboxPageDto>

---

markInboxProcessed()

markInboxProcessed(id): Promise<ActionResultDto>

Defined in: cap-dashboard-core/src/dashboard.service.ts:221

Parameters

id

string

Returns

Promise<ActionResultDto>

---

markOutboxPublished()

markOutboxPublished(id): Promise<ActionResultDto>

Defined in: cap-dashboard-core/src/dashboard.service.ts:146

Parameters

id

string

Returns

Promise<ActionResultDto>

---

retryInbox()

retryInbox(id, _opts?): Promise<ActionResultDto>

Defined in: cap-dashboard-core/src/dashboard.service.ts:198

Parameters

id

string

_opts?

RetryOptions

Returns

Promise<ActionResultDto>

---

retryOutbox()

retryOutbox(id, _opts?): Promise<ActionResultDto>

Defined in: cap-dashboard-core/src/dashboard.service.ts:116

Parameters

id

string

_opts?

RetryOptions

Returns

Promise<ActionResultDto>

This site is open source. Improve this page.