Class PlotAbstract

constructor

• new Plot(): Plot

  Returns Plot

AbstractcreateActivity

• createActivity(activity: NewActivity): Promise<Activity>

  Creates a new activity in the Plot system.

  The activity will be automatically assigned an ID and author information based on the current execution context. All other fields from NewActivity will be preserved in the created activity.

  Parameters

  • activity: NewActivity

    The activity data to create

  Returns Promise<Activity>

  Promise resolving to the complete created activity

AbstractcreateActivities

• createActivities(activities: NewActivity[]): Promise<Activity[]>

  Creates multiple activities in a single batch operation.

  This method efficiently creates multiple activities at once, which is more performant than calling createActivity() multiple times individually. All activities are created with the same author and access control rules.

  Parameters

  • activities: NewActivity[]

    Array of activity data to create

  Returns Promise<Activity[]>

  Promise resolving to array of created activities

AbstractupdateActivity

• updateActivity(activity: ActivityUpdate): Promise<void>

  Updates an existing activity in the Plot system.

  Only the fields provided in the update object will be modified - all other fields remain unchanged. This enables partial updates without needing to fetch and resend the entire activity object.

  For tags, provide a Record<number, boolean> where true adds a tag and false removes it. Tags not included in the update remain unchanged.

  When updating the parent, the activity's path will be automatically recalculated to maintain the correct hierarchical structure.

  When updating scheduling fields (start, end, recurrence*), the database will automatically recalculate duration and range values to maintain consistency.

  Parameters

  • activity: ActivityUpdate

    The activity update containing the ID and fields to change

  Returns Promise<void>

  Promise that resolves when the update is complete

  Example

  // Mark a task as complete
  await this.plot.updateActivity({
    id: "task-123",
    doneAt: new Date()
  });
  
  // Reschedule an event
  await this.plot.updateActivity({
    id: "event-456",
    start: new Date("2024-03-15T10:00:00Z"),
    end: new Date("2024-03-15T11:00:00Z")
  });
  
  // Add and remove tags
  await this.plot.updateActivity({
    id: "activity-789",
    tags: {
      1: true,  // Add tag with ID 1
      2: false  // Remove tag with ID 2
    }
  });
  
  // Update a recurring event exception
  await this.plot.updateActivity({
    id: "exception-123",
    occurrence: new Date("2024-03-20T09:00:00Z"),
    title: "Rescheduled meeting"
  });
  Copy

AbstractgetThread

• getThread(activity: Activity): Promise<Activity[]>

  Retrieves all activities in the same thread as the specified activity.

  A thread consists of related activities linked through parent-child relationships or other associative connections. This is useful for finding conversation histories or related task sequences.

  Parameters

  • activity: Activity

    The activity whose thread to retrieve

  Returns Promise<Activity[]>

  Promise resolving to array of activities in the thread

AbstractgetActivityByMeta

• getActivityByMeta(meta: ActivityMeta): Promise<Activity | null>

  Finds an activity by its metadata.

  This method enables lookup of activities that were created from external systems, using the metadata to locate the corresponding Plot activity. Useful for preventing duplicate imports and maintaining sync state.

  Parameters

  • meta: ActivityMeta

    The activity metadata to search for

  Returns Promise<Activity | null>

  Promise resolving to the matching activity or null if not found

AbstractcreatePriority

• createPriority(priority: NewPriority): Promise<Priority>

  Creates a new priority in the Plot system.

  Priorities serve as organizational containers for activities and twists. The created priority will be automatically assigned a unique ID.

  Parameters

  • priority: NewPriority

    The priority data to create

  Returns Promise<Priority>

  Promise resolving to the complete created priority

AbstractaddContacts

• addContacts(contacts: NewContact[]): Promise<Actor[]>

  Adds contacts to the Plot system.

  Contacts are used for associating people with activities, such as event attendees or task assignees. Duplicate contacts (by email) will be merged or updated as appropriate. This method requires ContactAccess.Write permission.

  Parameters

  • contacts: NewContact[]

    Array of contact information to add

  Returns Promise<Actor[]>

  Promise resolving to array of created/updated actors

AbstractgetActors

• getActors(ids: ActorId[]): Promise<Actor[]>

  Retrieves actors by their IDs.

  Actors represent users, contacts, or twists in the Plot system. This method requires ContactAccess.Read permission.

  Parameters

  • ids: ActorId[]

    Array of actor IDs to retrieve

  Returns Promise<Actor[]>

  Promise resolving to array of actors

Static ReadonlyOptions