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.

pexpireat #

Sets an expiration timestamp on a key. After the timestamp has been reached, the key will automatically be deleted.
The timestamp parameter accepts an Epoch time value, in milliseconds.

[Redis documentation]


pexpireat(key, timestamp, [options], [callback]) #

ArgumentsTypeDescription
keystringKey identifier
timestampintKey's expiration timestamp, in milliseconds
optionsJSON ObjectOptional parameters
callbackfunctionCallback

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Return Value #

Returns the MemoryStorage object to allow chaining.


Callback Response #

Returns a boolean specifying if the operation was successful or not.

Usage #

<?php
use \Kuzzle\Kuzzle;
$kuzzle = new Kuzzle('localhost');
try {
  $status = $kuzzle->memoryStorage()->pexpireat('key', 1488540242465);
}
catch (ErrorException $e) {
}

Callback response:

true