Interface Manager

公共组管理对象

公共组的增删改查

Hierarchy

Manager

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

公共组ID

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)

getByID

getByID: ((id) => PublicGroup)

Type declaration

- (id): PublicGroup
- 获取公共组对象
  Parameters
  - id: string
    公共组ID
  Returns PublicGroup

getByName

getByName: ((name) => PublicGroup)

Type declaration

- (name): PublicGroup
- 获取公共组对象
  Parameters
  - name: string
    公共组名
  Returns PublicGroup

getList

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

Type declaration

- (qo?): PublicGroup[]
- 获取公共组列表
  Parameters
  - Optional qo: "publicgroup".QueryOption
    查询参数
  Returns PublicGroup[]
  公共组列表（不包含成员信息）

getPortalUsersByID

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

Type declaration

- (pgID, qo?): string[]
- 获取成员业务用户
  Parameters
  - pgID: string
    公共组ID
  - Optional qo: "publicgroup".QueryOption
    查询参数
  Returns string[]

getPublicGroupsByID

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

Type declaration

- (pgID, qo?): string[]
- 获取成员公共组
  Parameters
  - pgID: string
    公共组ID
  - Optional qo: "publicgroup".QueryOption
    查询参数
  Returns string[]

getRolesAndSubsByID

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

Type declaration

- (pgID, qo?): string[]
- 获取成员角色及下属
  Parameters
  - pgID: string
    公共组ID
  - Optional qo: "publicgroup".QueryOption
    查询参数
  Returns string[]

getRolesByID

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

Type declaration

- (pgID, qo?): string[]
- 获取成员角色
  Parameters
  - pgID: string
    公共组ID
  - Optional qo: "publicgroup".QueryOption
    查询参数
  Returns string[]

getUsersByID

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

Type declaration

- (pgID, qo?): string[]
- 获取成员用户
  Parameters
  - pgID: string
    公共组ID
  - Optional qo: "publicgroup".QueryOption
    查询参数
  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

Interface Manager

Hierarchy

Index

Properties

Properties

addPortalUsersByID

Type declaration

Parameters

pgID: string

portalUserIDs: string[]

Returns void

addPublicGroupsByID

Type declaration

Parameters

pgID: string

groupIDs: string[]

Returns void

addRolesAndSubsByID

Type declaration

Parameters

pgID: string

RoleIDs: string[]

Returns void

addRolesByID

Type declaration

Parameters

pgID: string

RoleIDs: string[]

Returns void

addUsersByID

Type declaration

Parameters

pgID: string

userIDs: string[]

Returns void

create

Type declaration

Parameters

ps: PublicGroupOpts

Returns string

Example

getByID

Type declaration

Parameters

id: string

Returns PublicGroup

getByName

Type declaration

Parameters

name: string

Returns PublicGroup

getList

Type declaration

Parameters

Optional qo: "publicgroup".QueryOption

Returns PublicGroup[]

getPortalUsersByID

Type declaration

Parameters

pgID: string

Optional qo: "publicgroup".QueryOption

Returns string[]

getPublicGroupsByID

Type declaration

Parameters

pgID: string

Optional qo: "publicgroup".QueryOption

Returns string[]

getRolesAndSubsByID

Type declaration

Parameters

pgID: string

Optional qo: "publicgroup".QueryOption

Returns string[]

getRolesByID

Type declaration

Parameters

pgID: string

Optional qo: "publicgroup".QueryOption

Returns string[]

`Optional` qo: "publicgroup".QueryOption

`Optional` qo: "publicgroup".QueryOption

`Optional` qo: "publicgroup".QueryOption

`Optional` qo: "publicgroup".QueryOption

`Optional` qo: "publicgroup".QueryOption

`Optional` qo: "publicgroup".QueryOption