Constructor
# new SystemRelation(data)
Creates new system relation data
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object
|
Classes
Methods
# async static createRelation(ctx, target, type, conn) → {Promise.<SystemRelation>}
Creates relation
Parameters:
| Name | Type | Description |
|---|---|---|
ctx |
RequestContext
|
|
target |
User
|
|
type |
UserType
|
|
conn |
Pool
|
Promise.<SystemRelation>
# async static fromDatabase(data, ctx) → {SystemRelation}
Creates object from database
Parameters:
| Name | Type | Description |
|---|---|---|
data |
DBSystemRelation
|
DBSystemRelationAuthor
|
DBSystemRelationTarget
|
DBSystemRelationFull
|
|
ctx |
RequestContext
|
# async static getRelation(target, ctx, client) → {Promise.<(SystemRelation|null)>}
Gets current system relation
Parameters:
| Name | Type | Description |
|---|---|---|
target |
User
|
user |
ctx |
RequestContext
|
|
client |
UserClient
|
Systerm relation or null if default
Promise.<(SystemRelation|null)>
# async static getRelations(target, ctx) → {Promise.<Collection.<SystemRelation>>}
Gets all (even past) relations. Limits to 150.
Parameters:
| Name | Type | Description |
|---|---|---|
target |
User
|
|
ctx |
RequestContext
|
Promise.<Collection.<SystemRelation>>
# async static upsertRelation(ctx, target, type) → {Promise.<never>}
Creates or updates relation
Parameters:
| Name | Type | Description |
|---|---|---|
ctx |
RequestContext
|
|
target |
User
|
|
type |
UserType
|
- Deprecated:
- Yes
Promise.<never>
# async updateRelation(type) → {Promise.<SystemRelation>}
Updates relation
Parameters:
| Name | Type | Description |
|---|---|---|
type |
UserType
|
Promise.<SystemRelation>