Class BannedMembersRequestBuilder

Hierarchy

BannedMembersRequestBuilder

Index

Constructors

constructor

Methods

Constructors

constructor

new BannedMembersRequestBuilder(guid: string): BannedMembersRequestBuilder

Parameters
- guid: string
Returns BannedMembersRequestBuilder

Methods

build

build(): BannedMembersRequest

This method will return an object of the BannedMembersRequest class.

Returns BannedMembersRequest

setLimit

setLimit(limit: number): BannedMembersRequestBuilder

Parameters
- limit: number
  
  A method to set limit for the number of banned members returned in a single iteration. A maximum of 100 banned members can fetched in a single iteration.
Returns BannedMembersRequestBuilder

setScopes

setScopes(scopes: String[]): BannedMembersRequestBuilder

Parameters
- scopes: String[]
  
  A method to set the search banned members based on their scope.
Returns BannedMembersRequestBuilder

setSearchKeyword

setSearchKeyword(searchKeyword: string): BannedMembersRequestBuilder

Parameters
- searchKeyword: string
  
  A method to set the search string based on which the banned members are to be fetched.
Returns BannedMembersRequestBuilder