import {RelationContainer} from 'skygear-build/packages/skygear-core/lib/relation.js'
RelationContainer
Constructor Summary
Public Constructor | ||
public |
|
Member Summary
Public Members | ||
public get |
|
|
public get |
|
|
public get |
|
|
public get |
Query: RelationQuery Relation query class. |
|
public |
container: * |
Method Summary
Public Methods | ||
public |
async add(relation: Relation): Promise<RelationResult> Adds relation to the current user. |
|
public |
async query(queryObj: RelationQuery): Promise<RelationQueryResult> Queries users with a relation query object. |
|
public |
async queryFollower(): Promise<RelationQueryResult> Queries followers of current user. |
|
public |
async queryFollowing(): Promise<RelationQueryResult> Queries users that the current user is following. |
|
public |
async queryFriend(): Promise<RelationQueryResult> Queries friends of current user. |
|
public |
async remove(relation: Relation): Promise<RelationRemoveResult> Removes relation from the current user. |
Public Constructors
public constructor() source
Public Members
public container: * source
Public Methods
public async add(relation: Relation): Promise<RelationResult> source
Adds relation to the current user.
Params:
Name | Type | Attribute | Description |
relation | Relation |
public async query(queryObj: RelationQuery): Promise<RelationQueryResult> source
Queries users with a relation query object.
Params:
Name | Type | Attribute | Description |
queryObj | RelationQuery |
public async queryFollower(): Promise<RelationQueryResult> source
Queries followers of current user. Convenient method of RelationContainer#query.
public async queryFollowing(): Promise<RelationQueryResult> source
Queries users that the current user is following. Convenient method of RelationContainer#query.
public async queryFriend(): Promise<RelationQueryResult> source
Queries friends of current user. Convenient method of RelationContainer#query.
public async remove(relation: Relation): Promise<RelationRemoveResult> source
Removes relation from the current user.
Params:
Name | Type | Attribute | Description |
relation | Relation |