SDK
SDK Android v3.x
1

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

createDocument #

Create a new document in Kuzzle and instantiate a Document object.


createDocument(Document, [options], [callback]) #

ArgumentsTypeDescription
DocumentobjectDocument object
optionsJSON objectOptional parameters
callbackfunctionOptional callback

createDocument([id], content, [options], [callback]) #

ArgumentsTypeDescription
idstringOptional document identifier
contentJSON objectContent of the document to create
optionsJSON objectOptional parameters
callbackfunctionOptional callback

Options #

OptionTypeDescriptionDefault
volatileJSON objectAdditional information passed to notifications to other usersnull
queuablebooleanMake this request queuable or nottrue
refreshstringIf set to wait_for, Kuzzle will wait for the persistence layer to finish indexing (available with Elasticsearch 5.x and above)undefined
ifExiststringIf the same document already exists: resolves to an error. Replaces the existing document if set to replacefalse

Return Value #

Returns the Collection object to allow chaining.


Callback Response #

Returns a Document object containing the newly created document.

Usage #

Document myDocument = new Document(collection);
myDocument.setContent("title", "foo");
myDocument.setContent("content", "bar");
Options opts = new Options();
opts.setIfExist = "replace";
kuzzle
  .collection("collection", "index")
  .createDocument(myDocument, new ResponseListener<Document>() {
    @Override
    public void onSuccess(Document object) {
      // callback called once the create action has been completed
      // => the result is a Document object
    }
    @Override
    public void onError(JSONObject error) {
      // Handle error
    }
  });