Skip to main content

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#

NameType
connConnToken
ctxCtx
serviceUserServiceUser
groupIdstring

Returns#

Promise<Type<Group>>

Defined in#

src/service/domain/organization/group_query.ts:36


getGroups#

getGroups(conn, ctx, serviceUser): Promise<Type<Group[]>>

Parameters#

NameType
connConnToken
ctxCtx
serviceUserServiceUser

Returns#

Promise<Type<Group[]>>

Defined in#

src/service/domain/organization/group_query.ts:15


getGroupsForUser#

getGroupsForUser(conn, ctx, serviceUser, targetUserId): Promise<Type<Group[]>>

Parameters#

NameType
connConnToken
ctxCtx
serviceUserServiceUser
targetUserIdstring

Returns#

Promise<Type<Group[]>>

Defined in#

src/service/domain/organization/group_query.ts:58


groupExists#

groupExists(conn, ctx, serviceUser, groupId): Promise<Type<boolean>>

Parameters#

NameType
connConnToken
ctxCtx
serviceUserServiceUser
groupIdstring

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#

NameTypeDefault value
connConnTokenundefined
ctxCtxundefined
serviceUserServiceUserundefined
identitystringundefined
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
groupSetSet<string>undefined

Returns#

Promise<Type<Id[]>>

Defined in#

src/service/domain/organization/group_query.ts:95