Interface ScheduledHooksService

interface ScheduledHooksService {
    completeScheduledHook(
        scheduledHookId: string,
        completionNote: string,
    ): Promise<SavedScheduledHook<BaseModel>>;
    isHookScheduledForModel(hookId: string, modelId?: string): Promise<boolean>;
    isScheduledHookCompleted(scheduleHookId: string): Promise<boolean>;
    isScheduledHookDispatched(scheduleHookId: string): Promise<boolean>;
    markScheduledHookDispatched(
        scheduledHookId: string,
    ): Promise<SavedScheduledHook<BaseModel>>;
    rescheduleHooks<T extends BaseModel>(
        input: RescheduleHooksInput<T>,
    ): Promise<UpdateHooksSchedulingResult>;
    scheduleHook<T extends BaseModel>(
        input: ScheduleHookInput<T>,
    ): Promise<undefined | SavedScheduledHook<T>>;
    unscheduleHooks<T extends BaseModel>(
        input: UnscheduleHooksInput<T>,
    ): Promise<UpdateHooksSchedulingResult>;
}

Methods

completeScheduledHook isHookScheduledForModel isScheduledHookCompleted isScheduledHookDispatched markScheduledHookDispatched rescheduleHooks scheduleHook unscheduleHooks

Methods

completeScheduledHook

isHookScheduledForModel

  • isHookScheduledForModel(hookId: string, modelId?: string): Promise<boolean>

  • Checks if there is an active scheduled hook for a specific model and hook type.

    Parameters

    • hookId: string

      The ID of the hook type to check for

    • OptionalmodelId: string

      The ID of the model to check

    Returns Promise<boolean>

    • True if an active scheduled hook exists, false otherwise

isScheduledHookCompleted

isScheduledHookDispatched

markScheduledHookDispatched

rescheduleHooks

scheduleHook

unscheduleHooks

Settings

Member Visibility

On This Page

Methods