InterfaceApplicationUserListQueryParams

interface ApplicationUserListQueryParams {
    limit?: number;
    metaDataKeyFilter?: string;
    metaDataValuesFilter?: string[];
    nicknameStartsWithFilter?: string;
    userIdsFilter?: string[];
}

Hierarchy

  • BaseListQueryParams
    • ApplicationUserListQueryParams

Properties

limit? metaDataKeyFilter? metaDataValuesFilter? nicknameStartsWithFilter? userIdsFilter?

Properties

Optionallimit

limit?: number

Description

The maximum number of data per queried page.

OptionalmetaDataKeyFilter

metaDataKeyFilter?: string

Description

User meta data key filter. User list containing only and exactly the passed User meta data will be returned.

OptionalmetaDataValuesFilter

metaDataValuesFilter?: string[]

Description

User meta data values filter. User list containing only and exactly the passed User meta data will be returned.

OptionalnicknameStartsWithFilter

nicknameStartsWithFilter?: string

Description

A filter to return users whose nicknames start with the specified string.

OptionaluserIdsFilter

userIdsFilter?: string[]

Description

User IDs filter. User list containing the passed User IDs will be returned.

Settings

Member Visibility

On This Page

Properties