Class Page

constructor

• new Page(o: Page | PageCfg | PagePack): Page

  Parameters

  • o: Page | PageCfg | PagePack

  Returns Page

Optionalattributes

description

fixed_states

Optionalid

layout

min_role

name

title

Optionalupdated_at

html_file

• get html_file(): string | undefined

  Returns string | undefined

menu_label

• get menu_label(): string | undefined

  get menu label for page

  Returns string | undefined

authorize

• authorize(
      user: any,
      opts: { action: "get" | "post"; body?: Row; req: any; state?: Row },
  ): Promise<boolean>

  Checks plugin authorize_page hooks. Combine with the caller's own role/min_role check, e.g. role <= page.min_role || (await page.authorize(...)).

  Parameters

  • user: any

    the acting user (or undefined/public)

  • opts: { action: "get" | "post"; body?: Row; req: any; state?: Row }

    • action: "get" | "post"

      "get" or "post"

    • Optionalbody?: Row

      POST body, for action "post"

    • req: any

      the request object, forwarded to hooks

    • Optionalstate?: Row

      query/state, for action "get"

  Returns Promise<boolean>

clone

• clone(): Promise<Page>

  Clone page

  Returns Promise<Page>

connected_objects

• connected_objects(): ConnectedObjects

  Returns ConnectedObjects

delete

• delete(): Promise<void>

  Delete current page

  Returns Promise<void>

getStringsForI18n

• getStringsForI18n(): string[]

  Returns string[]

getTags

• getTags(): Promise<AbstractTag[]>

  Returns Promise<AbstractTag[]>

is_root_page_for_roles

• is_root_page_for_roles(): Promise<string[]>

  Is root page for role

  Returns Promise<string[]>

run

• run(
      querystate: any,
      extraArgs: RunExtra,
  ): Promise<Layout | { html_file: string } | { html_string: string } | null>

  Run (Show) page

  Parameters

  • querystate: any
  • extraArgs: RunExtra

  Returns Promise<Layout | { html_file: string } | { html_string: string } | null>

Staticcreate

• create(f: PageCfg | PagePack): Promise<Page>

  Create page

  Parameters

  • f: PageCfg | PagePack

  Returns Promise<Page>

Staticfind

• find(where?: Where, selectopts?: SelectOptions): Promise<Page[]>

  Find pages in DB

  Parameters

  • Optionalwhere: Where
  • selectopts: SelectOptions = ...

  Returns Promise<Page[]>

StaticfindOne

• findOne(where: Where): Page | undefined

  Find one page

  Parameters

  • where: Where

  Returns Page | undefined

StaticrenderEachEmbeddedPageInLayout

• renderEachEmbeddedPageInLayout(
      layout: Layout,
      querystate: Row,
      extraArgs: RunExtra,
  ): Promise<void>

  Parameters

  • layout: Layout
  • querystate: Row
  • extraArgs: RunExtra

  Returns Promise<void>

Staticstate_refresh

• state_refresh(): Promise<void>

  Returns Promise<void>

Staticupdate

• update(id: number, row: Row): Promise<void>

  Update page

  Parameters

  • id: number
  • row: Row

  Returns Promise<void>