SudoSOS Back-end API / GEWIS / Gewis
Class: Gewis ​
The GEWIS-specific module with definitions and helper functions.
Extends ​
Constructors ​
Constructor ​
ts
new Gewis(manager?): Gewis;Parameters ​
| Parameter | Type |
|---|---|
manager? | EntityManager |
Returns ​
Gewis
Inherited from ​
Properties ​
| Property | Modifier | Type | Inherited from |
|---|---|---|---|
manager | protected | EntityManager | WithManager.manager |
Methods ​
createMemberUser() ​
ts
createMemberUser(user, memberId): Promise<MemberUser>;Function that turns a local User into a Member User.
Parameters ​
| Parameter | Type | Description |
|---|---|---|
user | User | The local user |
memberId | number | Member ID of the user (e.g., GEWIS member ID) |
Returns ​
Promise<MemberUser>
createUserFromWeb() ​
ts
createUserFromWeb(token): Promise<MemberUser>;Function that creates a SudoSOS user based on the payload provided by the GEWIS Web token.
Parameters ​
| Parameter | Type | Description |
|---|---|---|
token | GewiswebToken | - |
Returns ​
Promise<MemberUser>
findOrCreateGEWISUserAndBind() ​
ts
findOrCreateGEWISUserAndBind(ADUser): Promise<User>;This function creates a new user if needed and binds it to a GEWIS number and AD account.
Parameters ​
| Parameter | Type | Description |
|---|---|---|
ADUser | LDAPUser | - |
Returns ​
Promise<User>