fullsyncrequestparameter.md

c8osdkjscore › FullSyncRequestParameter

Class: FullSyncRequestParameter

Hierarchy

• FullSyncRequestParameter

Index

Constructors

• constructor

Properties

• _name
• _type
• DESCENDING
• ENDKEY
• ENDKEY_DOCID
• GROUP
• GROUP_LEVEL
• INCLUDE_DELETED
• INCLUDE_DOCS
• INDEX_UPDATE_MODE
• KEY
• KEYS
• LIMIT
• REDUCE
• SKIP
• STARTKEY
• STARTKEY_DOCID

Accessors

• name
• type

Methods

• getFullSyncRequestParameter
• values

Constructors

Private constructor

+ new FullSyncRequestParameter(name: string, type: string): FullSyncRequestParameter

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:3

Parameters:

Name	Type
name	string
type	string

Returns: FullSyncRequestParameter

Properties

Private _name

• _name: string

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:2

---

Private _type

• _type: string

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:3

---

Static DESCENDING

▪ DESCENDING: FullSyncRequestParameter = new FullSyncRequestParameter("descending", "boolean")

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:17

---

Static ENDKEY

▪ ENDKEY: FullSyncRequestParameter = new FullSyncRequestParameter("endkey", "Object")

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:18

---

Static ENDKEY_DOCID

▪ ENDKEY_DOCID: FullSyncRequestParameter = new FullSyncRequestParameter("endkey_docid", "string")

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:19

---

Static GROUP

▪ GROUP: FullSyncRequestParameter = new FullSyncRequestParameter("group", "boolean")

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:28

---

Static GROUP_LEVEL

▪ GROUP_LEVEL: FullSyncRequestParameter = new FullSyncRequestParameter("group_level", "number")

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:20

---

Static INCLUDE_DELETED

▪ INCLUDE_DELETED: FullSyncRequestParameter = new FullSyncRequestParameter("include_deleted", "boolean")

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:21

---

Static INCLUDE_DOCS

▪ INCLUDE_DOCS: FullSyncRequestParameter = new FullSyncRequestParameter("include_docs", "boolean")

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:26

---

Static INDEX_UPDATE_MODE

▪ INDEX_UPDATE_MODE: FullSyncRequestParameter = new FullSyncRequestParameter("index_update_mode", "string")

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:22

---

Static KEY

▪ KEY: FullSyncRequestParameter = new FullSyncRequestParameter("key", "Array")

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:23

---

Static KEYS

▪ KEYS: FullSyncRequestParameter = new FullSyncRequestParameter("keys", "Array")

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:24

---

Static LIMIT

▪ LIMIT: FullSyncRequestParameter = new FullSyncRequestParameter("limit", "number")

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:25

---

Static REDUCE

▪ REDUCE: FullSyncRequestParameter = new FullSyncRequestParameter("reduce", "boolean")

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:27

---

Static SKIP

▪ SKIP: FullSyncRequestParameter = new FullSyncRequestParameter("skip", "number")

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:29

---

Static STARTKEY

▪ STARTKEY: FullSyncRequestParameter = new FullSyncRequestParameter("startkey", "Object")

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:30

---

Static STARTKEY_DOCID

▪ STARTKEY_DOCID: FullSyncRequestParameter = new FullSyncRequestParameter("startkey_docid", "string")

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:31

Accessors

name

• get name(): string

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:13

Returns: string

---

type

• get type(): string

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:9

Returns: string

Methods

Static getFullSyncRequestParameter

▸ getFullSyncRequestParameter(name: string): FullSyncRequestParameter

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:38

Parameters:

Name	Type
name	string

Returns: FullSyncRequestParameter

---

Static values

▸ values(): FullSyncRequestParameter[]

Defined in c8osdk-js-core/src/c8o/FullSyncRequestParameter.ts:33

Returns: FullSyncRequestParameter[]