Type Alias AdminSelectCanvasesRequest

AdminSelectCanvasesRequest: {
    allowed_ids?: Canvas["id"][];
    allowed_types?: (
        "canvas"
        | "canvas-template"
        | "section"
        | "section-template"
    )[];
    initial_metadata_filters?: Record<string, any>;
    selections?: CanvasSelection[];
    sequencing_key?: string;
}

Type declaration

  • Optionalallowed_ids?: Canvas["id"][]

    Array of canvas ids to include in the picker (optional).

  • Optionalallowed_types?: ("canvas" | "canvas-template" | "section" | "section-template")[]

    Array of canvas types to include in the picker (optional).

  • Optionalinitial_metadata_filters?: Record<string, any>

    Initial metadata filters to apply to the picker (optional).

  • Optionalselections?: CanvasSelection[]

    Array of selections.

  • Optionalsequencing_key?: string

    The sequencing key to use for ordering the canvases (optional).