@oneblink/apps-react
    Preparing search index...

    Interface NewTask

    interface NewTask {
        actionIds: string[];
        description?: string;
        formsAppEnvironmentId: number;
        linkedResources?: LinkedResource[];
        name: string;
        organisationId: string;
        schedule: {
            endDate?: string;
            recurrence:
                | { interval: "DAY" }
                | { day: DayOfWeek | DayOfWeek[]; interval: "WEEK" }
                | { days: number; interval: "CUSTOM" };
            startDate: string;
        };
        swipeLeftActionId?: string;
        swipeRightActionId?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    actionIds description? formsAppEnvironmentId linkedResources? name organisationId schedule swipeLeftActionId? swipeRightActionId?

    Properties

    actionIds: string[]

    The identifiers of available actions that the task can utilise within a Forms App. The order of the identifiers is respected when displaying actions.

    description?: string

    A description of the task

    formsAppEnvironmentId: number

    The identifier of the forms app environment the resource is associated with

    linkedResources?: LinkedResource[]

    Web links to resources associated with task

    name: string

    The name of the task

    organisationId: string

    The identifier of the organisation the resource is associated with

    schedule: {
        endDate?: string;
        recurrence:
            | { interval: "DAY" }
            | { day: DayOfWeek | DayOfWeek[]; interval: "WEEK" }
            | { days: number; interval: "CUSTOM" };
        startDate: string;
    }

    The schedule that will determine a task's frequency and date range

    Type Declaration

    • OptionalendDate?: string

      The date a task becomes unavailable

    • recurrence:
          | { interval: "DAY" }
          | { day: DayOfWeek | DayOfWeek[]; interval: "WEEK" }
          | { days: number; interval: "CUSTOM" }

      The sequence in which the task will occur

    • startDate: string

      The date a task becomes available

    swipeLeftActionId?: string

    Optional action identifiers for user swipe gestures

    swipeRightActionId?: string

    Settings

    On This Page

    Properties