Class DocumentResult

Schema for the result of a document modification.

Index

Constructors

Properties

causedBy? error? id ok? reason? ref? rev?

Methods

deserialize serialize

Constructors

constructor

new DocumentResult(): CloudantV1.DocumentResult
Returns CloudantV1.DocumentResult

Properties

`Optional`causedBy

causedBy?: string

The cause of the error (if available).

`Optional`error

error?: string

The name of the error.

id

id: string

Schema for a document ID.

`Optional`ok

ok?: boolean

ok.

`Optional`reason

reason?: string

The reason the error occurred (if available).

`Optional`ref

ref?: number

An internal error reference (if available).

`Optional`rev

rev?: string

Schema for a document revision identifier.

Methods

`Static`deserialize

deserialize(obj: any): CloudantV1.DocumentResult
Parameters
- obj: any
Returns CloudantV1.DocumentResult
- Defined in cloudant/v1.ts:13968

`Static`serialize

serialize(obj: any): CloudantV1.DocumentResult.Transport
Parameters
- obj: any
Returns CloudantV1.DocumentResult.Transport
- Defined in cloudant/v1.ts:13939