All types described on this page are exported fromDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/miu-ll/Cody-assistant/llms.txt
Use this file to discover all available pages before exploring further.
src/types.ts and shared between the renderer, the Electron main process, and the preload bridge. Import them directly in renderer code:
These types are used verbatim in the
window.desktop bridge methods. Passing
an object that does not match the expected shape will either be rejected by
the main-process validation helpers or silently coerced — always use the
correct types.Primitive Union Types
Priority
| Value | Meaning |
|---|---|
'urgent' | Requires immediate attention; surfaced at the top of task lists |
'high' | Important but not time-critical |
'normal' | Standard priority |
TaskStatus
| Value | Meaning |
|---|---|
'pending' | Task is active and incomplete |
'done' | Task has been completed |
Source
| Value | Meaning |
|---|---|
'email' | Extracted from an Outlook inbox item |
'calendar' | Derived from a calendar event |
'manual' | Created directly by the user |
Recurrence
| Value | Meaning |
|---|---|
'none' | One-time task |
'daily' | Repeats every day |
'weekly' | Repeats every week |
'biweekly' | Repeats every two weeks |
'monthly' | Repeats once a month |
PetVariant
AppSettings.petVariant.
Task
AppState.tasks.
Unique identifier for the task. Used as a key for reminder scheduling and
list reconciliation.
Short, human-readable task title displayed in lists and notifications.
Extended description or body of the task. May be empty.
Primary category label (e.g.
"Work", "Personal"). Categories are
managed in AppState.categories.Urgency level —
'urgent', 'high', or 'normal'.ISO 8601 date-time string for when the task is due. Optional; tasks
without a due date are considered undated.
Current lifecycle status —
'pending' or 'done'.Origin of the task —
'email', 'calendar', or 'manual'.AI confidence score in the range
0–1 for tasks extracted by the AI
pipeline. Manually created tasks should use 1.Email address or display name of the person who sent the originating
message. Present only for
source: 'email' tasks.Optional finer-grained classification within the primary
category.Optional custom workflow stage label (e.g.
"In Review", "Blocked").Optional assignee or owner name for delegated tasks.
Recurrence frequency. Defaults to
'none' when not set.ISO 8601 timestamp of when the task was created.
ISO 8601 timestamp of when the task was marked done.
InboxSuggestion
Task (minus status, since suggestions are pre-acceptance items) and adds two extra fields.
A short snippet from the originating email body, shown in the Inbox
review UI so the user can judge relevance before accepting the suggestion.
When
true, the AI classifier flagged this suggestion as low-confidence
or ambiguous and the user should review it before accepting. Defaults to
false when absent.All other fields (
id, title, detail, category, priority,
source, confidence, etc.) are inherited from Task. Refer to the
Task documentation above for their semantics.Meeting
AppState.meetings.
Unique identifier for the meeting (typically the Outlook entry ID or a
derived hash). Reminder IDs for meetings are prefixed with
meeting-
followed by this value.Subject line of the calendar event.
ISO 8601 date-time string for when the meeting begins.
ISO 8601 date-time string for when the meeting ends. Optional for
open-ended or all-day events.
List of attendee display names or email addresses.
Teams or other conferencing join URL. When present and the platform is
Windows, the reminder notification includes an action button that opens
this URL directly.
Physical or virtual location string from the calendar event.
Meeting format classification. Derived from the presence of a
joinUrl
and the calendar event body.AiProvider
| Value | Meaning |
|---|---|
'azure' | Azure OpenAI Service (requires endpoint and deployment) |
'openai' | OpenAI API (requires only apiKey) |
AiConfig
The AI backend to use —
'azure' or 'openai'.API key for the chosen provider. Stored in
AppSettings.aiApiKey.Base URL for Azure OpenAI Service (e.g.
https://my-resource.openai.azure.com/). Required when provider is
'azure'; unused for 'openai'.Azure deployment name (model deployment) to target. Required when
provider is 'azure'; unused for 'openai'.AppSettings
AppState.settings.
The user’s display name. Used in morning/closing briefing messages.
How many minutes before a meeting due time to fire a reminder
notification.
Interval in minutes between automatic Outlook syncs. When absent or
0,
automatic sync is disabled.When
true, Cody sends a morning briefing notification and an evening
closing briefing.Hour of the day (0–23) at which the morning briefing fires.
Hour of the day (0–23) at which the closing briefing fires.
UI text scale factor.
1 is the default; 1.25 increases text by 25%.Which pet character skin to display. Defaults to the app’s built-in
default when absent.
Whether Cody is registered to start automatically with Windows.
true once the user has completed the onboarding flow. Controls whether
the setup wizard is shown on startup.The AI provider selected by the user.
API key for the configured AI provider.
Azure OpenAI endpoint URL. Only relevant when
aiProvider is 'azure'.Azure deployment name. Only relevant when
aiProvider is 'azure'.The email address of the Outlook account used for COM sync. Populated
after the first successful sync.
ISO 8601 timestamp of the most recent successful Outlook sync.
AppState
loadData and saveData.
All active and completed tasks.
Pending inbox suggestions awaiting user review.
The full list of user-defined category labels (e.g.
["Work", "Personal", "Finance"]).Calendar events synced from Outlook.
User preferences and configuration. See
AppSettings.IDs of
InboxSuggestion items that the user explicitly dismissed
(neither accepted nor converted to a task). Used to prevent re-surfacing
the same suggestion after the next sync.ISO 8601 date string of the last day a morning briefing was sent.
Used to prevent duplicate briefings.
ISO 8601 date string of the last day a closing briefing was sent.
Reminder
scheduleReminder.
Unique identifier. Used to deduplicate and cancel reminders. Meeting
reminders should use the prefix
meeting- (e.g. "meeting-abc123") to
receive special Focus-mode handling.Notification title. Truncated to 240 characters by the main process.
Notification body text. Truncated to 240 characters by the main process.
ISO 8601 date-time string for when the notification should fire. Past
timestamps cause
scheduleReminder to return false.An optional
https:// URL. On Windows, the notification is rendered as
a rich Toast with an action button that opens this URL (useful for Teams
meeting join links). Non-HTTPS URLs are stripped.FocusMode
| Value | Behaviour |
|---|---|
'focus' | Suppresses non-meeting reminders; meeting reminders and ad-hoc notifications still fire |
'dnd' | Suppresses all reminders and notifications for the duration |
FocusState
getFocus and broadcast via onFocusChanged.
The active focus mode —
'focus' or 'dnd'.ISO 8601 date-time string representing when the focus session will
automatically end.
PetMood
| Value | Typical trigger |
|---|---|
'calm' | No pending urgent tasks |
'alert' | One or more high-priority tasks |
'worried' | One or more urgent tasks |
'happy' | A task was just completed (precedes a 'celebrate' update) |
PetUpdate
petUpdate and received via onPetUpdate. Always check payload.type before accessing other fields.
type: 'state' variant
Discriminant — identifies this as a state update.
The pet’s current mood. Controls which animation the pet plays.
Count of tasks currently in
priority: 'urgent' and status: 'pending'.
Displayed as a badge on the pet widget.Total count of tasks with
status: 'pending' (all priorities).When present, instructs the pet window to switch to this character skin.
Used when the user changes their pet in settings.
type: 'celebrate' variant
Discriminant — triggers a one-shot celebration animation in the pet
window. No additional fields.
OutlookSyncResult
syncOutlookClassic after a successful COM sync.
The email address of the Outlook account that was synced (e.g.
"alice@contoso.com"). Persisted to AppSettings.outlookAccount.New inbox suggestions extracted from unread emails, optionally classified
by the AI pipeline.
Calendar events found in the Outlook calendar for the look-ahead window.
Category labels discovered during the sync (from email folders or AI
classification). Merged into
AppState.categories.ISO 8601 timestamp of when the sync completed. Written to
AppSettings.lastOutlookSync.