Interface Manager

公共组管理对象

公共组的增删改查

interface Manager {
    addPortalUsersByID: ((pgID, portalUserIDs) => void);
    addPublicGroupsByID: ((pgID, groupIDs) => void);
    addRolesAndSubsByID: ((pgID, RoleIDs) => void);
    addRolesByID: ((pgID, RoleIDs) => void);
    addUsersByID: ((pgID, userIDs) => void);
    create: ((ps) => string);
    getByID: ((id) => PublicGroup);
    getByName: ((name) => PublicGroup);
    getList: ((qo?) => PublicGroup[]);
    getPortalUsersByID: ((pgID, qo?) => string[]);
    getPublicGroupsByID: ((pgID, qo?) => string[]);
    getRolesAndSubsByID: ((pgID, qo?) => string[]);
    getRolesByID: ((pgID, qo?) => string[]);
    getUsersByID: ((pgID, qo?) => string[]);
    remove: ((id) => void);
    removePortalUsersByID: ((pgID, portalUserIDs) => void);
    removePublicGroupsByID: ((pgID, groupIDs) => void);
    removeRolesAndSubsByID: ((pgID, RoleIDs) => void);
    removeRolesByID: ((pgID, RoleIDs) => void);
    removeUsersByID: ((pgID, userIDs) => void);
}

Properties

addPortalUsersByID addPublicGroupsByID addRolesAndSubsByID addRolesByID addUsersByID create getByID getByName getList getPortalUsersByID getPublicGroupsByID getRolesAndSubsByID getRolesByID getUsersByID remove removePortalUsersByID removePublicGroupsByID removeRolesAndSubsByID removeRolesByID removeUsersByID

Properties

addPortalUsersByID

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

添加业务用户

Type declaration

    • (pgID, portalUserIDs): void

    • Parameters

      • pgID: string
      • portalUserIDs: string[]

      Returns void

addPublicGroupsByID

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

添加公共组

Type declaration

    • (pgID, groupIDs): void

    • Parameters

      • pgID: string
      • groupIDs: string[]

      Returns void

addRolesAndSubsByID

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

添加角色及下属

Type declaration

    • (pgID, RoleIDs): void

    • Parameters

      • pgID: string
      • RoleIDs: string[]

      Returns void

addRolesByID

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

添加角色

Type declaration

    • (pgID, RoleIDs): void

    • Parameters

      • pgID: string
      • RoleIDs: string[]

      Returns void

addUsersByID

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

添加用户

Type declaration

    • (pgID, userIDs): void

    • Parameters

      • pgID: string
      • userIDs: string[]

      Returns void

create

create: ((ps) => string)

创建公共组

Type declaration

    • (ps): string

    • Parameters

      • ps: PublicGroupOpts

        公共组参数，必选参数name，label，memberMap，且memberMap至少包含一个成员。

      Returns string

Example


import * as pg from "publicgroup"

let mgr = pg.newManager()
let id = mgr.create({ name: "kwtest",
                      label: "kwtest",
                      memberMap: { user: ["10gd000000En2xfeFqQy"] } })
let publicGroup = mgr.getByID(id)

Returns

公共组ID

getByID

getByID: ((id) => PublicGroup)

获取公共组对象

Type declaration

getByName

getByName: ((name) => PublicGroup)

获取公共组对象

Type declaration

getList

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

获取公共组列表

Type declaration

Returns

公共组列表（不包含成员信息）

getPortalUsersByID

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

获取成员业务用户

Type declaration

    • (pgID, qo?): string[]

    • Parameters

      Returns string[]

getPublicGroupsByID

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

获取成员公共组

Type declaration

    • (pgID, qo?): string[]

    • Parameters

      Returns string[]

getRolesAndSubsByID

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

获取成员角色及下属

Type declaration

    • (pgID, qo?): string[]

    • Parameters

      Returns string[]

getRolesByID

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

获取成员角色

Type declaration

    • (pgID, qo?): string[]

    • Parameters

      Returns string[]

getUsersByID

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

获取成员用户

Type declaration

    • (pgID, qo?): string[]

    • Parameters

      Returns string[]

remove

remove: ((id) => void)

删除公共组

Type declaration

    • (id): void

    • Parameters

      • id: string

        公共组ID

      Returns void

removePortalUsersByID

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

移除成员业务用户

Type declaration

    • (pgID, portalUserIDs): void

    • Parameters

      • pgID: string
      • portalUserIDs: string[]

      Returns void

removePublicGroupsByID

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

移除成员公共组

Type declaration

    • (pgID, groupIDs): void

    • Parameters

      • pgID: string
      • groupIDs: string[]

      Returns void

removeRolesAndSubsByID

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

移除成员角色及下属

Type declaration

    • (pgID, RoleIDs): void

    • Parameters

      • pgID: string
      • RoleIDs: string[]

      Returns void

removeRolesByID

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

移除成员角色

Type declaration

    • (pgID, RoleIDs): void

    • Parameters

      • pgID: string
      • RoleIDs: string[]

      Returns void

removeUsersByID

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

移除成员用户

Type declaration

    • (pgID, userIDs): void

    • Parameters

      • pgID: string
      • userIDs: string[]

      Returns void

Settings

Member Visibility

Theme

On This Page

addPortalUsersByIDaddPublicGroupsByIDaddRolesAndSubsByIDaddRolesByIDaddUsersByIDcreategetByIDgetByNamegetListgetPortalUsersByIDgetPublicGroupsByIDgetRolesAndSubsByIDgetRolesByIDgetUsersByIDremoveremovePortalUsersByIDremovePublicGroupsByIDremoveRolesAndSubsByIDremoveRolesByIDremoveUsersByID