Module: core/occurrence
Interfaces
Functions
useActivityEditor
▸ useActivityEditor(online): Object
Parameters
| Name | Type |
|---|---|
online | Activity |
Returns
Object
| Name | Type |
|---|---|
activity | Object |
activity.completed_at | null | string |
activity.created_at | string |
activity.doc | Object |
activity.doc.definitionUri? | string |
activity.doc.delay? | number |
activity.doc.delayUnit? | "a" | "s" | "min" | "h" | "d" | "wk" | "mo" |
activity.doc.description? | string |
activity.doc.end_at? | string |
activity.doc.exdate? | string[] |
activity.doc.instantiatesCanonical? | string |
activity.doc.last_completed_at? | string |
activity.doc.reminders? | Reminder[] |
activity.doc.repeatBoundsPeriodEnd? | string |
activity.doc.repeatBoundsPeriodStart? | string |
activity.doc.repeatCount? | number |
activity.doc.repeatDayOfWeek? | ("mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun")[] |
activity.doc.repeatDuration? | number |
activity.doc.repeatDurationMax? | number |
activity.doc.repeatDurationUnit? | "a" | "s" | "min" | "h" | "d" | "wk" | "mo" |
activity.doc.repeatFrequency? | number |
activity.doc.repeatFrequencyMax? | number |
activity.doc.repeatOffset? | number |
activity.doc.repeatPeriod? | number |
activity.doc.repeatPeriodUnit? | "a" | "s" | "min" | "h" | "d" | "wk" | "mo" |
activity.doc.repeatTimeOfDay? | string[] |
activity.doc.scheduledTiming? | Object |
activity.doc.scheduledTiming.repeat | Object |
activity.doc.scheduledTiming.repeat.period? | string |
activity.doc.scheduledTiming.repeat.periodUnit? | string |
activity.doc.title? | string |
activity.end_at | null | string |
activity.expired_at | null | string |
activity.hidden? | boolean |
activity.id | string |
activity.kind | "Appointment" | "Article" | "Questionnaire" | "Task" | "Message" |
activity.parent_id | null | string |
activity.planned_at | string |
activity.questionnaire? | Questionnaire |
activity.questionnaire_response? | QuestionnaireResponse |
activity.reminder_at | null | string |
activity.started_at | null | string |
activity.status | "scheduled" | "in-progress" | "completed" | "stopped" | "not-started" |
activity.uid | string |
create | () => Promise<void> |
dirty | number |
patchActivity | (data: Partial<Activity>) => void |
patchActivityDoc | (data: Partial<ActivityDoc>) => void |
remove | () => Promise<void> |
repeating | boolean |
reschedule | (strategy?: "all" | "single" | "future") => Promise<undefined | { success: boolean }> |