SDK
SDK PHP 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.

publish #

Publishes the content of this document as a real-time message.


publish([options]) #

ArgumentsTypeDescription
optionsJSON ObjectOptional parameters

Options #

OptionTypeDescriptionDefault
volatileJSON ObjectAdditional information passed to notifications to other usersnull
queuablebooleanMake this request queuable or nottrue

Return Value #

Returns this Document object to allow chaining.

Usage #

<?php
use \Kuzzle\Document;
// ...
/**
  * @var $document Document
  */
try {
  $document->publish();
} catch (ErrorException $e) {
}