Interface AddressBookEntrySearchParams

interface AddressBookEntrySearchParams {
    addressBookId?: string;
    attributes?: string;
    filter?: string;
    page?: number;
    pageSize?: number;
    search?: string;
    sortBy?: string;
    sortOrder?: "asc" | "desc";
}

Hierarchy

  • BaseSearchParams
    • AddressBookEntrySearchParams

Properties

addressBookId? attributes? filter? page? pageSize? search? sortBy? sortOrder?

Properties

Optional addressBookId

addressBookId?: string

Optional attributes

attributes?: string

Attributes to be returned

Optional filter

filter?: string

Filter criteria using RSQL syntax

Optional page

page?: number

Page number (starts from 0)

Optional pageSize

pageSize?: number

Number of items per page

Optional search

search?: string

Search keyword

Optional sortBy

sortBy?: string

Sort field

Optional sortOrder

sortOrder?: "asc" | "desc"

Sort direction

Settings

Member Visibility

Theme

On This Page

addressBookIdattributesfilterpagepageSizesearchsortBysortOrder