Work Queue Management Object

Add, delete, modify, and query work queues.

Hierarchy

  • Manager

Properties

addPortalUsersByID: ((qID, portalUserIDs) => void)

Type declaration

    • (qID, portalUserIDs): void
    • Adding a Service User

      Parameters

      • qID: string
      • portalUserIDs: string[]

      Returns void

addPublicGroupsByID: ((qID, groupIDs) => void)

Type declaration

    • (qID, groupIDs): void
    • Add Public Group

      Parameters

      • qID: string
      • groupIDs: string[]

      Returns void

addRolesAndSubsByID: ((qID, RoleIDs) => void)

Type declaration

    • (qID, RoleIDs): void
    • Add Roles and Subordinates

      Parameters

      • qID: string
      • RoleIDs: string[]

      Returns void

addRolesByID: ((qID, RoleIDs) => void)

Type declaration

    • (qID, RoleIDs): void
    • Add Role

      Parameters

      • qID: string
      • RoleIDs: string[]

      Returns void

addUsersByID: ((qID, userIDs) => void)

Type declaration

    • (qID, userIDs): void
    • Adding a user

      Parameters

      • qID: string
      • userIDs: string[]

      Returns void

create: ((ps) => string)

Type declaration

    • (ps): string
    • create work queue

      Parameters

      • ps: QueueOpts

        Parameter for creating a work queue. Mandatory parameters: name, label, and memberMap. The memberMap must contain at least one member.

      Returns string

      Role ID

      Example

      import * as queue from "queue"
      let mgr = queue.newManager()
      let id = mgr.create({ name: "test",
      label: "test",
      memberMap: { user: [{user id},] } })
      let testQueue = mgr.getByID(id)
getByID: ((id) => Queue)

Type declaration

    • (id): Queue
    • Get Work Queue

      Parameters

      • id: string

        Work Queue ID

      Returns Queue

getByName: ((name) => Queue)

Type declaration

    • (name): Queue
    • Get Work Queue

      Parameters

      • name: string

        Work Queue Name

      Returns Queue

getList: ((qo?) => Queue[])

Type declaration

    • (qo?): Queue[]
    • Obtain the work queue list.

      Parameters

      Returns Queue[]

      Work queue list (excluding member information and queue object information)

getPortalUsersByID: ((qID, qo?) => string[])

Type declaration

    • (qID, qo?): string[]
    • Obtaining a Member Service User

      Parameters

      Returns string[]

getPublicGroupsByID: ((qID, qo?) => string[])

Type declaration

    • (qID, qo?): string[]
    • Obtains the public group of members.

      Parameters

      Returns string[]

getRolesAndSubsByID: ((qID, qo?) => string[])

Type declaration

    • (qID, qo?): string[]
    • Obtain member roles and subordinates.

      Parameters

      Returns string[]

getRolesByID: ((qID, qo?) => string[])

Type declaration

    • (qID, qo?): string[]
    • Obtaining Member Roles

      Parameters

      Returns string[]

getUsersByID: ((qID, qo?) => string[])

Type declaration

    • (qID, qo?): string[]
    • Obtaining Member Users

      Parameters

      Returns string[]

remove: ((id) => void)

Type declaration

    • (id): void
    • Delete Work Queue

      Parameters

      • id: string

        Work Queue ID

      Returns void

removePortalUsersByID: ((qID, portalUserIDs) => void)

Type declaration

    • (qID, portalUserIDs): void
    • Remove Member Service User

      Parameters

      • qID: string
      • portalUserIDs: string[]

      Returns void

removePublicGroupsByID: ((qID, groupIDs) => void)

Type declaration

    • (qID, groupIDs): void
    • Remove Member Public Group

      Parameters

      • qID: string
      • groupIDs: string[]

      Returns void

removeRolesAndSubsByID: ((qID, RoleIDs) => void)

Type declaration

    • (qID, RoleIDs): void
    • Remove Member Roles and Subordinates

      Parameters

      • qID: string
      • RoleIDs: string[]

      Returns void

removeRolesByID: ((qID, RoleIDs) => void)

Type declaration

    • (qID, RoleIDs): void
    • Remove Member Role

      Parameters

      • qID: string
      • RoleIDs: string[]

      Returns void

removeUsersByID: ((qID, userIDs) => void)

Type declaration

    • (qID, userIDs): void
    • Remove Member User

      Parameters

      • qID: string
      • userIDs: string[]

      Returns void