Class ListSearchResponse

The response object with the list search hits and additional information regarding pagination.

Constructors

constructor

Properties

hasMore lists offset total attributeTypeMap discriminator mapping

Methods

getAttributeTypeMap

Constructors

constructor

Properties

hasMore

hasMore: boolean

Whether or not there are more results to page through.

lists

lists: PublicObjectListSearchResult[]

The lists that matched the search criteria.

offset

offset: number

Value to be passed in a future request to paginate through list search results.

total

total: number

The total number of lists that match the search criteria.

Static ReadonlyattributeTypeMap

attributeTypeMap: {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[] = ...

Static Readonlydiscriminator

discriminator: undefined | string = undefined

Static Readonlymapping

mapping: undefined | {
    [index: string]: string;
} = undefined

Methods

StaticgetAttributeTypeMap

  • getAttributeTypeMap(): {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

  • Returns {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

Settings

Member Visibility

On This Page

Constructors
Properties
Methods