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.
pexpireat(key, timestamp, [options], [callback]) #
Arguments | Type | Description |
---|---|---|
key | string | Key identifier |
timestamp | int | Key's expiration timestamp, in milliseconds |
options | JSON Object | Optional parameters |
callback | function | Callback |
Options #
Option | Type | Description | Default |
---|---|---|---|
queuable | boolean | Make this request queuable or not | true |
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
Edit this page on Github(opens new window)