Reference Source
import JSONStoreAddOptions from 'react-native-ibm-mobilefirst-jsonstore'
public class | source

JSONStoreAddOptions

Options that are used to control the add operation in JSONStoreCollection.

Constructor Summary

Public Constructor
public

constructor(markDirty: string, additionalSearchFields: JSON)

Constructor

Member Summary

Public Members
public
public

Method Summary

Public Methods
public

addAdditionalSearchField(key: string, value: any)

Add an additional search field for the add operation.

public

addAdditionalSearchFields(extraSearchFields: JSON)

Add multiple additional search fields for the add operation.

Public Constructors

public constructor(markDirty: string, additionalSearchFields: JSON) source

Constructor

Params:

NameTypeAttributeDescription
markDirty string
  • optional

Flag to mark a document dirty. Default is false.

additionalSearchFields JSON
  • optional

additional search fields for the add operation.

Public Members

public additionalSearchFields: * source

public markDirty: boolean source

Public Methods

public addAdditionalSearchField(key: string, value: any) source

Add an additional search field for the add operation.

Params:

NameTypeAttributeDescription
key string

The key of additional search field to include with the document.

value any

The value of additional search field for 'key' to include with the document. Accepted value types are: ('string', 'boolean', 'integer', 'number')

public addAdditionalSearchFields(extraSearchFields: JSON) source

Add multiple additional search fields for the add operation.

Params:

NameTypeAttributeDescription
extraSearchFields JSON

An JSON Object that contains key/value pairs for additional search fields.