diff options
| author | Joas Schilling <nickvergessen@owncloud.com> | 2015-11-24 11:10:45 +0300 |
|---|---|---|
| committer | Joas Schilling <nickvergessen@owncloud.com> | 2015-11-24 11:10:45 +0300 |
| commit | 7292d2cbbbaff3ed168cb2aca7307a0a0623be2d (patch) | |
| tree | 0cfbd39514be109f55f5e86e2e58ef105558a471 /docs | |
| parent | f79aebfbaa12af3b185f1eaa4a1018aad29f5c09 (diff) | |
Fix language
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/notification-workflow.md | 8 | ||||
| -rw-r--r-- | docs/ocs-endpoint-v1.md | 4 |
2 files changed, 6 insertions, 6 deletions
diff --git a/docs/notification-workflow.md b/docs/notification-workflow.md index bf06fa0..c059972 100644 --- a/docs/notification-workflow.md +++ b/docs/notification-workflow.md @@ -1,9 +1,9 @@ -# Notification Workflow as an App that sends Notifications +# Notification Workflow for an App that sends Notifications ## Example story Let's assume the following example scenario. Our app is the files_sharing app. We want -to notify the user when a remote share has to be accepted/decline. If the user has dealt +to notify the user when a remote share has to be accepted/declined. If the user has dealt with it, we want to remove the notification again. ### Creating a new Notification @@ -117,7 +117,7 @@ with it, we want to remove the notification again. ### Marking a notification as read/deleted/processed/obsoleted -Now in case the user accepted the share or the share was removed/unshared, we want to remove +If the user accepted the share or the share was removed/unshared, we want to remove the notification, because no user action is needed anymore. To do this, we simply have to call the `markProcessed()` method on the manager with the neccessary information on a notification object: @@ -130,7 +130,7 @@ $notification->setApp('files_sharing') $manager->markProcessed($notification); ``` -Thereby only the app name is mandatory: so if you don't set the user, the notification +Only the app name is mandatory: so if you don't set the user, the notification will be marked as processed for all users that have it. So the following example will remove all notifications for the app files_sharing on the object "remote #1337": diff --git a/docs/ocs-endpoint-v1.md b/docs/ocs-endpoint-v1.md index f456feb..8e059b4 100644 --- a/docs/ocs-endpoint-v1.md +++ b/docs/ocs-endpoint-v1.md @@ -69,7 +69,7 @@ The user needs to be identified/logged in by the server. Then you can just run a } ``` -**Note:** In case the Request return status code `204` (No content), you can slow down the polling to once per hour. This status code means that there is no app, that can generate notifications. +**Note:** If the HTTP status code is `204` (No content), you can slow down the polling to once per hour. This status code means that there is no app that can generate notifications. ### Specification @@ -89,7 +89,7 @@ app | string | Name of the app that triggered the notification user | string | User id of the user that receives the notification datetime | string | ISO 8601 date and time when the notification was published object_type | string | Type of the object the notification is about, that can be used in php to mark a notification as resolved -object_id | string | Type of the object the notification is about, that can be used in php to mark a notification as resolved +object_id | string | ID of the object the notification is about, that can be used in php to mark a notification as resolved subject | string | Translated short subject that should be presented to the user message | string | (Optional) Translated potentially longer message that should be presented to the user link | string | (Optional) A link that should be followed when the subject/message is clicked |