masterplan-optimizer-frontend / mpBackendApi
Variable: mpBackendApi¶
constmpBackendApi:object
Defined in: src/lib/api.ts:2623
Client wrapper for MP-Backend publish settings and export operations.
Type Declaration¶
acknowledgeDataPolicy¶
acknowledgeDataPolicy: (
eventId,policyVersion,policySha256) =>Promise\<void>
Record an explicit pseudonymous local acknowledgement of an exact policy.
Parameters¶
eventId¶
number
policyVersion¶
number
policySha256¶
string
Returns¶
Promise\<void>
deleteSettings¶
deleteSettings: (
eventId) =>Promise\<void>
Delete MP-Backend publish settings for an event.
Parameters¶
eventId¶
number
Returns¶
Promise\<void>
exportSetup¶
exportSetup: (
eventId) =>Promise\<ExportSetupData>
Export event setup data in the MP-Backend bootstrap format.
Parameters¶
eventId¶
number
Returns¶
Promise\<ExportSetupData>
getDataPolicy¶
getDataPolicy: (
eventId) =>Promise\<MpBackendDataPolicy>
Fetch the exact Server policy and this installation's acknowledgement state.
Parameters¶
eventId¶
number
Returns¶
Promise\<MpBackendDataPolicy>
getDeletionWorkOrderStatus¶
getDeletionWorkOrderStatus: (
eventId) =>Promise\<DeletionWorkOrderStatusResult>
Check for pending work orders without claiming or applying them.
Parameters¶
eventId¶
number
Returns¶
Promise\<DeletionWorkOrderStatusResult>
getSettings¶
getSettings: (
eventId) =>Promise\<MpBackendSettings>
Fetch MP-Backend publish settings for an event.
Parameters¶
eventId¶
number
Returns¶
Promise\<MpBackendSettings>
ping¶
ping: (
eventId) =>Promise\<MpBackendPingResult>
Check whether the configured MP-Backend endpoint is reachable.
Parameters¶
eventId¶
number
Returns¶
Promise\<MpBackendPingResult>
publish¶
publish: (
eventId,dates?) =>Promise\<MpBackendPublishResult>
Publish one event's final schedule, optionally limited to specific days, to MP-Backend.
Parameters¶
eventId¶
number
dates?¶
string[]
Returns¶
Promise\<MpBackendPublishResult>
publishGeneralSchedule¶
publishGeneralSchedule: (
eventId,dates?) =>Promise\<GeneralSchedulePublishResult>
Publish all or selected working days of an event's Public Schedule.
Parameters¶
eventId¶
number
dates?¶
string[]
Returns¶
Promise\<GeneralSchedulePublishResult>
retryDeletionReports¶
retryDeletionReports: () =>
Promise\<DeletionWorkOrderSyncResult>
Retry durable privacy reports after their local event has been erased.
Returns¶
Promise\<DeletionWorkOrderSyncResult>
saveSettings¶
saveSettings: (
eventId,serverUrl,publishSecret) =>Promise\<MpBackendSettings>
Save MP-Backend publish settings for an event.
Parameters¶
eventId¶
number
serverUrl¶
string
publishSecret¶
string
Returns¶
Promise\<MpBackendSettings>
syncDeletionWorkOrders¶
syncDeletionWorkOrders: (
eventId) =>Promise\<DeletionWorkOrderSyncResult>
Apply deletion work orders locally and send privacy-safe reports.
Parameters¶
eventId¶
number
Returns¶
Promise\<DeletionWorkOrderSyncResult>