feat(realtime): add docs #54
Conversation
app/views/docs/realtime.phtml
Outdated
| <div class="notice calm margin-top-large margin-bottom-large"> | ||
| <h3>Permissions</h3> | ||
| <p>All subscriptions are secured by the <a href="/docs/permissions">permissions</a> offered by Appwrite, meaning a user will only receive updates to resources to which he has read permission.</p> | ||
| <p>Using a wildcard (<span class="tag">*</span>) on read permissions will allow any client to receive updates.</p> |
There was a problem hiding this comment.
Note to change * to read:all after the db refactor
| "payload": { | ||
| "$id": "[DOCUMENT_ID]", | ||
| "$collection": "[COLLECTION_ID]", | ||
| "$permissions": [], |
There was a problem hiding this comment.
Note: we need to update this example after the DB refactor. $permissions will be replaced with $read and $write
| <p>Nested Documents will not trigger events related to their parent documents. Meaning, updates to a child document - will not trigger an event for the parent document. But it will trigger an event for the child document itself.</p> | ||
|
|
||
| <h3>Server-Side?</h3> | ||
| <p>We currently are not offering access to realtime with Server SDKs and an API key.</p> No newline at end of file |
There was a problem hiding this comment.
Can we allow the use with a JWT key?
There was a problem hiding this comment.
Yes, that will work out of the box 👍🏻
There was a problem hiding this comment.
So we should probably mention that on the tutorial? at least say that only an api-key is not yet supported, or have a complete section for server side integration? maybe just an external tutorial?
Co-authored-by: Eldad A. Fux <eldad.fux@gmail.com>
Co-authored-by: Eldad A. Fux <eldad.fux@gmail.com>
Co-authored-by: Eldad A. Fux <eldad.fux@gmail.com>
Co-authored-by: Eldad A. Fux <eldad.fux@gmail.com>
… feat-realtime
|
Would be great to also get a screenshot of the light mode. Let's change the name on the tabs from |
lohanidamodar
left a comment
lohanidamodar
left a comment
There was a problem hiding this comment.
Small query, rest looks good at the moment, will give another review once Flutter examples are added
|
@TorstenDittmann do you think maybe we should add a section about authentication? |
Uh oh!
There was an error while loading. Please reload this page.