Class PageGroup

constructor

• new PageGroup(cfg): PageGroup

• Parameters

  • cfg: PageGroupCfg

  Returns PageGroup

Optional description

Optional id

members

min_role

name

random_allocation

addMember

• addMember(cfg, noRrefresh?): Promise<PageGroupMember>

• add a member to this group

  Parameters

  • cfg: PageGroupMemberCfg

  • Optional noRrefresh: boolean

  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): AbstractPageGroupMember[]

• find a member

  Parameters

  • where: any

  Returns AbstractPageGroupMember[]

getEligiblePage

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

• 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 }

  • Optional locale: string

  Returns Promise<null | Page>

  the matching page, or null

loadPages

• loadPages(): Promise<Page[]>

• Returns Promise<Page[]>

moveMember

• moveMember(member, mode): Promise<void>

• manipulate the sequence of a member

  Parameters

  • member: AbstractPageGroupMember

  • mode: "Up" | "Down"

  Returns Promise<void>

removeMember

• removeMember(id): 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

Static create

• create(cfg, noTransaction?): Promise<PageGroup>

• create a new group and add members

  Parameters

  • cfg: PageGroupCfg

  • Optional noTransaction: boolean

  Returns Promise<PageGroup>

  the created group

Static delete

• delete(where): Promise<void>

• delete a group

  Parameters

  • where: number | Where

  Returns Promise<void>

Static find

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

• find groups

  Parameters

  • Optional where: Where

  • selectopts: SelectOptions = ...

  Returns Promise<PageGroup[]>

  an array of page groups

Static findOne

• findOne(where): null | PageGroup

• find one group

  Parameters

  • where: Where

  Returns null | PageGroup

  one page group or null

Static update

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

• update a group

  Parameters

  • id: number

    id of the group

  • row: Row

    values to update

  Returns Promise<void>