service/domain/organization/group_query
Api Code Documentation / Exports / service/domain/organization/group_query
Table of contents#
Functions#
Functions#
getGroup#
â–¸ getGroup(conn, ctx, serviceUser, groupId): Promise<Type<Group>>
Parameters#
| Name | Type |
|---|---|
conn | ConnToken |
ctx | Ctx |
serviceUser | ServiceUser |
groupId | string |
Returns#
Defined in#
src/service/domain/organization/group_query.ts:36
getGroups#
â–¸ getGroups(conn, ctx, serviceUser): Promise<Type<Group[]>>
Parameters#
| Name | Type |
|---|---|
conn | ConnToken |
ctx | Ctx |
serviceUser | ServiceUser |
Returns#
Defined in#
src/service/domain/organization/group_query.ts:15
getGroupsForUser#
â–¸ getGroupsForUser(conn, ctx, serviceUser, targetUserId): Promise<Type<Group[]>>
Parameters#
| Name | Type |
|---|---|
conn | ConnToken |
ctx | Ctx |
serviceUser | ServiceUser |
targetUserId | string |
Returns#
Defined in#
src/service/domain/organization/group_query.ts:58
groupExists#
â–¸ groupExists(conn, ctx, serviceUser, groupId): Promise<Type<boolean>>
Parameters#
| Name | Type |
|---|---|
conn | ConnToken |
ctx | Ctx |
serviceUser | ServiceUser |
groupId | string |
Returns#
Promise<Type<boolean>>
Defined in#
src/service/domain/organization/group_query.ts:75
resolveUsers#
â–¸ resolveUsers(conn, ctx, serviceUser, identity, getGroupFn?, getUserFn?, groupSet?): Promise<Type<Id[]>>
returns all users for given identity if identity is an user return it, else if identity is group resolve identities of the group
Parameters#
| Name | Type | Default value |
|---|---|---|
conn | ConnToken | undefined |
ctx | Ctx | undefined |
serviceUser | ServiceUser | undefined |
identity | string | undefined |
getGroupFn | (conn: ConnToken, ctx: Ctx, serviceUser: ServiceUser, groupId: string) => Promise<Type<Group>> | getGroup |
getUserFn | (conn: ConnToken, ctx: Ctx, serviceUser: ServiceUser, userId: string) => Promise<Type<UserRecord>> | getUser |
groupSet | Set<string> | undefined |