From fc955864df73a9aee9d6db9d95ad2421d55393cc Mon Sep 17 00:00:00 2001
From: Maxence Lange <maxence@artificial-owl.com>
Date: Fri, 6 Sep 2019 10:02:16 -0100
Subject: [PATCH] fix and documentatio

---
 README.md              | 67 ++++++++++++++++++++++++++++++++++--------
 lib/Command/Test.php   |  1 -
 lib/Db/PushRequest.php |  1 +
 3 files changed, 56 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 0b13f0e..ba2007d 100644
--- a/README.md
+++ b/README.md
@@ -167,22 +167,65 @@ If you want to create an object that is only broadcast to callbacks, you can cre
 
 
 
+### Update an existing item
+
+It is possible to create unique item that can be edited over time.
+
+This is used in the Social App when a new account is following yours; the notification is identified by a **keyword** (here: _new_followers_).
+Please note that the _Time To Live_ is set to `TTL_FEW_HOUR`
+```php
+    $userId = 'cult';
+
+    $notification = new \OC\Push\Model\Helper\PushNotification('social', IPushItem::TTL_FEW_HOURS);
+    $notification->setTitle('Nextcloud Social');
+    $notification->setLevel(PushNotification::LEVEL_SUCCESS);
+    $notification->setMessage('accountA is following you');
+    $notification->addMetaArray('accounts', ['accountA']);
+    $notification->setKeyword('new_followers');      // identification of the PushItem
+    $notification->addUser($userId);
+
+    $pushHelper = $this->pushManager->getPushHelper();
+    $pushHelper->pushNotification($notification);
+```
+
+
+Now, before creating this notification, we should have checked that there is no already existing notifications about _new_followers_in the queue:
+ 
+
+
+```php
+$pushService = $this->pushManager->getPushService();
+    try {
+        $item = $pushService->getItemByKeyword('social', $userId, 'new_followers');
+        // already exists, get the current item, edit its content and save the edited object
+    } catch (ItemNotFoundException $e) {
+        // does not exists, create a new one.
+    }
+```
+
+
+If the precedent notification about _new_followers_ have been read by the recipient, we create a new one. If the recipient haven't read it, we can still edit the item:
+
+```php
+    $item->addMetaArray('accounts', 'accountB');
+    $accounts = $item->getMeta('accounts');
+    $newMessage = implode(', ', $accounts) . ' are now following you');
+
+    $payload = $item->getPayload();
+    $payload['message'] = $newMessage;
+    $item->setPayload($payload);
+    $pushService = $this->pushManager->getPushService();
+    $pushService->update($item);
+```
+
+_Note about `push()` and `update()`_:
+- `push()` will create a new item and erase any old item with the same keyword/userId/appId.
+- `update()`will only update existing item. There is no confirmation if the item was already published before or not.
 
 
 ### yay, animation.
 
+This is the Social App using the Push App to update its front-end when a new message is received.
 ![](https://raw.githubusercontent.com/nextcloud/push/master/documentations/SocialPush.gif)
 
 
-
-n=5
-
-- si init du poll: 
-* on recupere tous les published=0
-* on recupere tous les published de moins de n secondes
-
-
-- si pas init du poll:
-* on affiche tout
-
-rajouter un delay depuis le JS pour relancer le poll
diff --git a/lib/Command/Test.php b/lib/Command/Test.php
index 30fdb42..779df26 100644
--- a/lib/Command/Test.php
+++ b/lib/Command/Test.php
@@ -149,7 +149,6 @@ class Test extends Base {
 			$notification->setKeyword('test');
 			$notification->setMessage("If you cannot see this, it means it is not working.");
 			$notification->addUser($userId);
-
 			$pushHelper = $this->pushManager->getPushHelper();
 			$pushHelper->pushNotification($notification);
 
diff --git a/lib/Db/PushRequest.php b/lib/Db/PushRequest.php
index 4155113..3185a9a 100644
--- a/lib/Db/PushRequest.php
+++ b/lib/Db/PushRequest.php
@@ -178,6 +178,7 @@ class PushRequest extends PushRequestBuilder {
 		$qb->limitToApp($app);
 		$qb->limitToKeyword($keyword);
 		$qb->limitToUserId($userId);
+		$qb->andWhere($qb->exprLimitToDBFieldInt('published', 0, '', true));
 
 		return $this->getItemFromRequest($qb);
 	}