Class GroupsRequestBuilder

Hierarchy

GroupsRequestBuilder

Index

Constructors

constructor

Methods

Constructors

constructor

new GroupsRequestBuilder(): GroupsRequestBuilder

Returns GroupsRequestBuilder

Methods

build

build(): GroupsRequest

This method will return an object of the GroupsRequest class.

Returns GroupsRequest

joinedOnly

joinedOnly(hasJoined: boolean): GroupsRequestBuilder

A method to fetch only joined groups.

Parameters
- hasJoined: boolean
Returns GroupsRequestBuilder

setLimit

setLimit(limit: number): GroupsRequestBuilder

Parameters
- limit: number
  
  A method to set limit for the number of Groups returned in a single iteration. A maximum of 100 groups can fetched in a single iteration.
Returns GroupsRequestBuilder

setSearchKeyword

setSearchKeyword(searchKeyword: string): GroupsRequestBuilder

Parameters
- searchKeyword: string
  
  A method to set the search string based on which the groups are to be fetched.
Returns GroupsRequestBuilder

setTags

setTags(tags: String[]): GroupsRequestBuilder

Parameters
- tags: String[]
  
  A method to set the tags based on which the groups are to be fetched.
Returns GroupsRequestBuilder

withTags

withTags(withTags: boolean): GroupsRequestBuilder

Parameters
- withTags: boolean
  
  A method to get the tags along with the other details of the groups.
Returns GroupsRequestBuilder