import {RelationContainer} from 'skygear-build/packages/skygear-core/lib/relation.js'

public class | source

RelationContainer

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public get	Follower: Relation
public get	Following: Relation
public get	Friend: Relation
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 get Follower: Relation source

public get Following: Relation source

public get Friend: Relation source

public get Query: RelationQuery source

Relation query class.

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

Return:

Promise<RelationResult>

promise with user records

public async query(queryObj: RelationQuery): Promise<RelationQueryResult> source

Queries users with a relation query object.

Params:

Name	Type	Attribute	Description
queryObj	RelationQuery

Return:

Promise<RelationQueryResult>

promise with user records

public async queryFollower(): Promise<RelationQueryResult> source

Queries followers of current user. Convenient method of RelationContainer#query.

Return:

Promise<RelationQueryResult>

promise with user records

public async queryFollowing(): Promise<RelationQueryResult> source

Queries users that the current user is following. Convenient method of RelationContainer#query.

Return:

Promise<RelationQueryResult>

promise with user records

public async queryFriend(): Promise<RelationQueryResult> source

Queries friends of current user. Convenient method of RelationContainer#query.

Return:

Promise<RelationQueryResult>

promise with user records

public async remove(relation: Relation): Promise<RelationRemoveResult> source

Removes relation from the current user.

Params:

Name	Type	Attribute	Description
relation	Relation

Return:

Promise<RelationRemoveResult>

promise with user id