Type Alias ListViewEntryOptions

ListViewEntryOptions: {
    category?: string[];
    column?: string;
    count?: number;
    direction?: SortShort;
    distinctDocuments?: boolean;
    documents?: boolean;
    ftSearchQuery?: string;
    key?: string[];
    keyAllowPartial?: boolean;
    keyType?: "number" | "text" | "time";
    markRead?: boolean;
    markUnread?: boolean;
    meta?: boolean;
    metaAdditional?: boolean;
    mode?: string;
    pivotColumn: string;
    richTextAs?: string;
    scope?: ViewEntryScopes;
    start?: number;
    startKey?: string;
    startsWith?: string;
    unreadOnly?: boolean;
    untilKey?: string;
}

Type declaration

  • Optionalcategory?: string[]

    Category to restrict view queries to

  • Optionalcolumn?: string

    Column for alternative sorting. This requires the list to be designed for indexing on this column

  • Optionalcount?: number

    How many entries shall be returned, default = 1000

  • Optionaldirection?: SortShort

    The direction for alternative sorting. This is ignored unless "column" query parameter is passed as well. This requires the list to be designed for indexing on this column in the desired direction. Defaults to ascending if column is set.

  • OptionaldistinctDocuments?: boolean

    Determines whether, when documents=true, only distinct documents should be retrieved if they exist multiple times in the list.

  • Optionaldocuments?: boolean

    Shall the query return documents instead of view entries

  • OptionalftSearchQuery?: string

    Full-text search query to filter the contents of the list

  • Optionalkey?: string[]

    Useful for categorized or sorted lists. Limits return values to entries matching the key or keys. Use multiple key parameter items to specify multiple keys in request URL. The keys specified must be in the same order as the sorted columns from left to right. Unsorted columns will be ignored.

  • OptionalkeyAllowPartial?: boolean

    Select by partial Key. Default is false (key match is exact)

  • OptionalkeyType?: "number" | "text" | "time"

    The type of the keys used in startKey and untilKey

  • OptionalmarkRead?: boolean

    When retrieving documents instead of view entries, mark them as read by the current user after retrieval

  • OptionalmarkUnread?: boolean

    When retrieving documents instead of view entries, mark them as unread by the current user after retrieval

  • Optionalmeta?: boolean

    When set to false, all metadata Json items on the top level of an object get suppressed. Default is true

  • OptionalmetaAdditional?: boolean

    Additional metadata that is not included in the View. This may have a slight performance cost so use only if necessary.

  • Optionalmode?: string

    Document mode to retrieve the documents with. (Every Form can have multiple modes, each can be different from other modes). Also, Current logged-in user must have access for the specified mode.

  • pivotColumn: string

    Name of the column to provide the data for the pivot aggregator

  • OptionalrichTextAs?: string

    The format RichText fields will be returned when retrieving documents instead of view entries. The default if unspecified is mime.

  • Optionalscope?: ViewEntryScopes

    What shall the view return:

    • document entries
    • category names
    • all
  • Optionalstart?: number

    At which entry should return values start (zero based), default = 0

  • OptionalstartKey?: string

    Key value for the first entry to retrieve. This is treated as a greater-than-or-equal lookup

  • OptionalstartsWith?: string

    A character combination to perform a partial match to identify a starting point. The character combination will be applied to the "column" and "direction" passed in the query string. This cannot be combined with the "keys" parameter, i.e. you cannot filter on keys and startwith within that key.

  • OptionalunreadOnly?: boolean

    Retrieve only unread entries. Cannot be combined with documents=true, documentsOnly=true, or methods to select or query documents

  • OptionaluntilKey?: string

    Key value to stop traversal when used in combination with startKey. This is treated as a greater-than-or-equal lookup and represents the first value to not return

Settings

Member Visibility