Interface IterParticipantsParams

Used in iterParticipant and getParticipant. all params are optional.

interface IterParticipantsParams {
    filter?: TypeChannelParticipantsFilter;
    limit?: number;
    offset?: number;
    search?: string;
    showTotal?: boolean;
}

Properties

optional filter to be used. E.g only admins filter or only banned members filter. PS : some filters need more permissions.

limit?: number

how many members to retrieve. defaults to Number.MAX_SAFE_INTEGER (everyone)

offset?: number

how many members to skip. defaults to 0

search?: string

a query string to filter participants based on their display names and usernames. defaults to "" (everyone)

showTotal?: boolean

whether to call an extra request (GetFullChannel) to show the total of users in the group/channel. if set to false total will be 0