NexconnChatSDK/ai.nexconn.chat.params/GroupMembersByRoleQueryParams

GroupMembersByRoleQueryParams

public final class GroupMembersByRoleQueryParams

Pagination query parameters for group members filtered by role.

Used by ai.nexconn.chat.channel.GroupChannel.createGroupMembersByRoleQuery to create a pagination query object.

Usage example:

val params = GroupMembersByRoleQueryParams(groupId = "group_123").apply {
    role = GroupMemberRole.MANAGER
    pageSize = 50
    filterRobotType = GroupMemberFilterRobotType.EXCLUDE_ROBOT
}
val query = GroupChannel.createGroupMembersByRoleQuery(params)
query.loadNextPage { list, error -> ... }

Constructors

GroupMembersByRoleQueryParams

public GroupMembersByRoleQueryParams GroupMembersByRoleQueryParams(String groupId)

Properties

filterRobotType

private GroupMemberFilterRobotType filterRobotType

Filter robot type. Default GroupMemberFilterRobotType.ALL returns all members including robots.

private final String groupId

Group ID

private Boolean isAscending

Whether to sort in ascending order. true: ascending; false: descending (default)

private Integer pageSize

Number of items per page. Defaults to 20, maximum 100

private GroupMemberRole role

Group member role. Defaults to UNDEF, which queries all types

Functions

getFilterRobotType

public final GroupMemberFilterRobotType getFilterRobotType()

Filter robot type. Default GroupMemberFilterRobotType.ALL returns all members including robots.

public final String getGroupId()

Group ID

public final Integer getPageSize()

Number of items per page. Defaults to 20, maximum 100

public final GroupMemberRole getRole()

Group member role. Defaults to UNDEF, which queries all types

public final Boolean isAscending()

Whether to sort in ascending order. true: ascending; false: descending (default)

public final Unit setAscending(Boolean isAscending)

Whether to sort in ascending order. true: ascending; false: descending (default)

setFilterRobotType

public final Unit setFilterRobotType(GroupMemberFilterRobotType filterRobotType)

Filter robot type. Default GroupMemberFilterRobotType.ALL returns all members including robots.

public final Unit setPageSize(Integer pageSize)

Number of items per page. Defaults to 20, maximum 100

public final Unit setRole(GroupMemberRole role)

Group member role. Defaults to UNDEF, which queries all types