Class PageGroup

constructor

• new PageGroup(cfg: PageGroupCfg): PageGroup

  Parameters

  • cfg: PageGroupCfg

  Returns PageGroup

Optionaldescription

Optionalid

members

min_role

name

random_allocation

addMember

• addMember(cfg: PageGroupMemberCfg): Promise<PageGroupMember>

  add a member to this group

  Parameters

  • cfg: PageGroupMemberCfg

  Returns Promise<PageGroupMember>

clearMembers

• clearMembers(): Promise<void>

  clear all members from this group

  Returns Promise<void>

clone

• clone(): Promise<PageGroup>

  duplicate this group with a new name

  Returns Promise<PageGroup>

  the created group

connected_objects

• connected_objects(): ConnectedObjects

  Returns ConnectedObjects

delete

• delete(): Promise<void>

  delete this group

  Returns Promise<void>

findMember

• findMember(where: any): AbstractPageGroupMember[]

  find a member

  Parameters

  • where: any

  Returns AbstractPageGroupMember[]

getEligiblePage

• getEligiblePage(
      data: ScreenInfoParams,
      user: any,
      locale?: string,
  ): Promise<Page | null>

  determine the first page in the group that matches the client screen size

  Parameters

  • data: ScreenInfoParams

    client screen and window size

  • user: any

    the user or just { role_id: 100 }

  • Optionallocale: string

  Returns Promise<Page | null>

  the matching page, or null

loadPages

• loadPages(): Promise<Page[]>

  Returns Promise<Page[]>

moveMember

• moveMember(member: AbstractPageGroupMember, mode: "Up" | "Down"): Promise<void>

  manipulate the sequence of a member

  Parameters

  • member: AbstractPageGroupMember
  • mode: "Up" | "Down"

  Returns Promise<void>

removeMember

• removeMember(id: number): Promise<void>

  remove a member from this group

  Parameters

  • id: number

    id of the member

  Returns Promise<void>

sortedMembers

• sortedMembers(): AbstractPageGroupMember[]

  Returns AbstractPageGroupMember[]

  the members sorted by sequence

Staticcreate

• create(cfg: PageGroupCfg): Promise<PageGroup>

  create a new group and add members

  Parameters

  • cfg: PageGroupCfg

  Returns Promise<PageGroup>

  the created group

Staticdelete

• delete(where: number | Where): Promise<void>

  delete a group

  Parameters

  • where: number | Where

  Returns Promise<void>

Staticfind

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

  find groups

  Parameters

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

  Returns Promise<PageGroup[]>

  an array of page groups

StaticfindOne

• findOne(where: Where): PageGroup | null

  find one group

  Parameters

  • where: Where

  Returns PageGroup | null

  one page group or null

Staticupdate

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

  update a group

  Parameters

  • id: number

    id of the group

  • row: Row

    values to update

  Returns Promise<void>