getsocial-react-native-sdk/models/communities/GroupsQuery.js

React Native wrapper for GetSocial iOS and Android SDK

/* eslint-disable max-len */
// @flow
import UserId from './../UserId.js';

/**
 * GroupsQuery object.
 */
export default class GroupsQuery {
    search: ?string;
    followerId: ?UserId;
    memberId: ?UserId;
    trending: boolean = false;
    labels: Array<string> = [];
    properties: {[key: string] : string} = {};

    /**
    * Get all groups.
    *
    * @return {GroupsQuery} new instance.
    */
    static all(): GroupsQuery {
        const instance = new GroupsQuery();
        return instance;
    }

    /**
    * Find groups by name or description.
    *
    * @param {string} searchTerm groups name/description or part of it.
    * @return {GroupsQuery} new instance.
    */
    static find(searchTerm: string): GroupsQuery {
        const instance = new GroupsQuery();
        instance.search = searchTerm;
        return instance;
    }

    /**
    * Get groups followed by a specific user.
    *
    * @param {UserId} userId ID of user.
    * @return {GroupsQuery} same instance.
    */
    followedBy(userId: UserId): GroupsQuery {
        this.followerId = userId;
        return this;
    }

    /**
    * Get groups by member.
    *
    * @param {UserId} userId ID of user.
    * @return {GroupsQuery} same instance.
    */
    withMember(userId: UserId): GroupsQuery {
        this.memberId = userId;
        return this;
    }

    /**
    * Get only trending groups.
    *
    * @param {boolean} trending Only trending groups or all.
    * @return {GroupsQuery} same query.
    */
    onlyTrending(trending: boolean): GroupsQuery {
        this.trending = trending;
        return this;
    }

    /**
     * Get groups matching the specified properties.
     *
     * @param {Object<string, string>} properties Properties.
     * @return {GroupsQuery} same query.
     */
    withProperties(properties: {[key: string] : string}): GroupsQuery {
        this.properties = properties;
        return this;
    }

    /**
     * Get groups matching the specified labels.
     *
     * @param {[string]} labels Labels list.
     * @return {GroupsQuery} same query.
     */
    withLabels(labels: string[]): GroupsQuery {
        this.labels = labels;
        return this;
    }

    /**
    * Generates JSON string.
    * @return {string} object as json.
    */
    toJSON() {
        return {followerId: this.followerId ?? null, labels: this.labels ?? null, memberId: this.memberId ?? null, properties: this.properties ?? null, searchTerm: this.search ?? null, trending: this.trending};
    }
}