Group

Anrop	Beskrivning	Kodexempel
count()	Number	let group = sp3.group() let groupCount = await group.count() return groupCount
create( document, opt ) opt = { parent: string }	Information about the group creation. JSON	let group = sp3.group() let newGroup = await group.create( {name: "newGroup"}, {parent: "parentGroupId"} ) return newGroup.result
expand(groupIds)	Array with the given groupIds extended with parents. [ "group1Id", "group1ParentId", "group1ParentParentId", ... "group2Id", "group2ParentId", ... ]	let group = sp3.group() let expandedIds = await group.expand( [ "group1Id", "group2Id" ] ) return expandedIds
get( groupId, opt ) opt = { withUsers: boolean }	Group represented in JSON	let group = sp3.group() let fetchedGroup = await group.get( "groupId / groupName", {withUsers: true}, ) return fetchedGroup
gets( null, opt ) opt = { fields: obj, asMap: boolean, asParentsMap: boolean, dangerously: boolean, baseGroup: string, name: string, }	Array of groups represented in chosen fields. JSON fields: {name: 1, _id: 1} [ { "_id": "group1._id", "name": "group1.name" }, { "_id": "group2._id", "name": "group2.name" }, ... ]	let group = sp3.group() let allGroups = await group.gets( null, // <-- Dont forget to put something here { // Value does not matter. fields: { name: 1, _id: 1, parentId: 1 } } ) return allGroups
getUsersInGroup( applicationRef, groupId, opt ) otp = { roles: array, traverse: boolean, userObj: boolean }	Array of userIds. Use all options like in the example to extend the entries with remaining user data. Minimal input: otp = { roles: [""], traverse: true, userObj: true }	let group = sp3.group() let adminGroupUsers = await group.getUsersInGroup( "admin", "groupId", { roles: ["roleId1", "roleId2"] traverse: true, userObj: true } ) return adminGroupUsers
remove(groupId)	Information about the deletion. JSON	let group = sp3.group() let removed = await group.remove("groupId") return removed.result
update( groupId, data )	Information about the update. JSON	let group = sp3.group() let updated = await group.update( "groupId", { name: "newGroupName", parentId: "newParentId" } ) return updated.result
validate(groupName)	Boolean	let group = sp3.group() let isValid = await group.validate("groupName") // isValid = true if "groupName" is a string and NOT taken return isValid