backends-web-backend

---

Class: TeamsService

Defined in: backends/web-backend/src/teams/teams.service.ts:75

Implements

• OnModuleInit

Constructors

Constructor

new TeamsService(teamModel, userModel, orgsService, eventBus, storage): TeamsService

Defined in: backends/web-backend/src/teams/teams.service.ts:76

Parameters

teamModel

Model<Document<unknown, { }, Team, { }, { }> & Team & object & object>

userModel

Model<Document<unknown, { }, User, { }, { }> & User & object & object>

orgsService

OrgsService

eventBus

EventBus

storage

StorageService

Returns

TeamsService

Methods

acceptInvite()

acceptInvite(id, username): Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; memberCount: number; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>

Defined in: backends/web-backend/src/teams/teams.service.ts:319

Parameters

id

string

username

string

Returns

Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; memberCount: number; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>

---

bulkInvite()

bulkInvite(id, identifiers, acting): Promise<{ results: object[]; }>

Defined in: backends/web-backend/src/teams/teams.service.ts:274

Parameters

id

string

identifiers

string[]

acting

string

Returns

Promise<{ results: object[]; }>

---

cancelInvite()

cancelInvite(id, target, acting): Promise<void>

Defined in: backends/web-backend/src/teams/teams.service.ts:311

Parameters

id

string

target

string

acting

string

Returns

Promise<void>

---

clearAvatar()

clearAvatar(id, acting): Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; memberCount: number; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>

Defined in: backends/web-backend/src/teams/teams.service.ts:377

Parameters

id

string

acting

string

Returns

Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; memberCount: number; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>

---

createTeam()

createTeam(payload, username): Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; memberCount: number; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>

Defined in: backends/web-backend/src/teams/teams.service.ts:102

Parameters

payload

description

string = ...

name

string = ...

organization

string = ...

visibility

"public" | "private" = ...

username

string

Returns

Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; memberCount: number; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>

---

declineInvite()

declineInvite(id, username): Promise<void>

Defined in: backends/web-backend/src/teams/teams.service.ts:337

Parameters

id

string

username

string

Returns

Promise<void>

---

deleteTeam()

deleteTeam(id, username): Promise<void>

Defined in: backends/web-backend/src/teams/teams.service.ts:220

Parameters

id

string

username

string

Returns

Promise<void>

---

demoteFromLead()

demoteFromLead(id, target, acting): Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; memberCount: number; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>

Defined in: backends/web-backend/src/teams/teams.service.ts:250

Parameters

id

string

target

string

acting

string

Returns

Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; memberCount: number; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>

---

getAvailableTeams()

getAvailableTeams(username, query): Promise<{ teams: object[]; }>

Defined in: backends/web-backend/src/teams/teams.service.ts:134

Parameters

username

string

query

string | undefined

Returns

Promise<{ teams: object[]; }>

---

getMyInvitations()

getMyInvitations(username): Promise<{ teams: object[]; }>

Defined in: backends/web-backend/src/teams/teams.service.ts:126

Parameters

username

string

Returns

Promise<{ teams: object[]; }>

---

getMyTeams()

getMyTeams(username): Promise<{ teams: object[]; }>

Defined in: backends/web-backend/src/teams/teams.service.ts:118

Parameters

username

string

Returns

Promise<{ teams: object[]; }>

---

getTeamDetail()

getTeamDetail(id, username): Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; invited: object[]; memberCount: number; members: object[]; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>

Defined in: backends/web-backend/src/teams/teams.service.ts:150

Parameters

id

string

username

string

Returns

Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; invited: object[]; memberCount: number; members: object[]; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>

---

inviteUser()

inviteUser(id, identifier, acting): Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; memberCount: number; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>

Defined in: backends/web-backend/src/teams/teams.service.ts:259

Parameters

id

string

identifier

string

acting

string

Returns

Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; memberCount: number; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>

---

joinTeam()

joinTeam(id, username): Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; memberCount: number; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>

Defined in: backends/web-backend/src/teams/teams.service.ts:173

Parameters

id

string

username

string

Returns

Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; memberCount: number; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>

---

kickMember()

kickMember(id, target, acting): Promise<void>

Defined in: backends/web-backend/src/teams/teams.service.ts:345

Parameters

id

string

target

string

acting

string

Returns

Promise<void>

---

leaveTeam()

leaveTeam(id, username): Promise<void>

Defined in: backends/web-backend/src/teams/teams.service.ts:192

Parameters

id

string

username

string

Returns

Promise<void>

---

onModuleInit()

onModuleInit(): Promise<void>

Defined in: backends/web-backend/src/teams/teams.service.ts:84

Returns

Promise<void>

Implementation of

OnModuleInit.onModuleInit

---

promoteToLead()

promoteToLead(id, target, acting): Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; memberCount: number; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>

Defined in: backends/web-backend/src/teams/teams.service.ts:239

Parameters

id

string

target

string

acting

string

Returns

Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; memberCount: number; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>

---

setAvatar()

setAvatar(id, file, acting): Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; memberCount: number; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>

Defined in: backends/web-backend/src/teams/teams.service.ts:359

Parameters

id

string

file

buffer

Buffer

mimetype

string

originalname

string

size

number

acting

string

Returns

Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; memberCount: number; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>

---

transferAdmin()

transferAdmin(id, target, acting): Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; memberCount: number; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>

Defined in: backends/web-backend/src/teams/teams.service.ts:227

Parameters

id

string

target

string

acting

string

Returns

Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; memberCount: number; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>

---

updateTeam()

updateTeam(id, payload, username): Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; memberCount: number; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>

Defined in: backends/web-backend/src/teams/teams.service.ts:206

Parameters

id

string

payload

description?

string = ...

name?

string = ...

organization?

string = ...

visibility?

"public" | "private" = ...

username

string

Returns

Promise<{ adminUsername: string; avatarUrl: string | null; description: string; id: string; memberCount: number; name: string; organization: string; role: "admin" | "lead" | "member" | "invited" | null; visibility: "public" | "private"; }>