Interface GetLocalDocumentParams

Parameters for the getLocalDocument operation.

interface GetLocalDocumentParams {
    accept?: string;
    attEncodingInfo?: boolean;
    attachments?: boolean;
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
    localSeq?: boolean;
}

Properties

accept? attEncodingInfo? attachments? db docId headers? ifNoneMatch? localSeq?

Properties

Optional accept

accept?: string

The type of the response: application/json, multipart/mixed, multipart/related, or application/octet-stream.

Optional attEncodingInfo

attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular attachment is compressed.

Optional attachments

attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

db

db: string

Path parameter to specify the database name.

docId

docId: string

Path parameter to specify the document ID.

Optional headers

headers?: OutgoingHttpHeaders

Optional ifNoneMatch

ifNoneMatch?: string

Header parameter to specify a double quoted document revision token for cache control.

Optional localSeq

localSeq?: boolean

Query parameter to specify whether to include the last update sequence for the document.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc