Χρήση Συνδρομών
Οι συνδρομές είναι χρήσιμες για πραγματικό χρόνο UX όπως:
- πρόοδος μεταφόρτωσης
- πρόοδος ασύγχρονων εργασιών
- ενημερώσεις κύκλου ζωής εγγράφου και παραλήπτη
- αλλαγές πιστώσεων
Για το ίδιο το σχήμα του φορτίου, δείτε:
Ανάλυση του Εσωτερικού Φορτίου Γεγονότος
Το πεδίο συνδρομής επιστρέφει:
- έναν περιέκτη παράδοσης (
userIdήgroupId) - ένα JSON string στο
data
Πάντοτε αναλύετε την εσωτερική τιμή data πριν χειριστείτε το γεγονός.
const parseEnvelope = (payload) => {
const raw = payload?.data;
if (!raw) return null;
return typeof raw === 'string' ? JSON.parse(raw) : raw;
};
Κατεύθυνση βάση category και event
Θεωρήστε:
- το
categoryως οικογένεια γεγονότων - το
eventως τη συγκεκριμένη ενέργεια ή κατάσταση ροής εργασίας
Παραδείγματα:
category: "upload",event: "uploadCompleted"category: "task",event: "taskCreditBlocked"category: "documentLifecycle",event: "documentCreated"category: "recipientLifecycle",event: "recipientVisiting"
Κανόνες Παράδοσης
- Το
subscribeUserFeedχρησιμοποιείται για γεγονότα που απευθύνονται σε χρήστες όπως η πρόοδος μεταφόρτωσης και κάποιες διασπορές κύκλου ζωής. - Το
subscribeGroupFeedχρησιμοποιείται για γεγονότα που απευθύνονται σε ομάδες όπως ενημερώσεις εγγράφων, παραληπτών, προτύπων, εργασιών, πιστώσεων και κύκλου ζωής. - Ορισμένα γεγονότα διανέμονται και στις δύο ροές με το ίδιο
eventId.
Οδηγίες Συμβατότητας
Αν μετακινείστε από τα παλαιότερα απλά φορτία συνδρομών:
- αναλύστε πρώτα τον εσωτερικό φάκελο
data - μετακινήστε την δρομολόγηση γεγονότων στο
eventαντί για το παλαιότεροsystemMessage - χρησιμοποιήστε το
categoryγια να αποφασίσετε πώς θα ερμηνεύσετε τοdata - συνεχίστε να αγνοείτε άγνωστα πεδία
data
Αντιπροσωπευτικά Ονόματα Γεγονότων
Συνηθισμένα ονόματα γεγονότων περιλαμβάνουν:
documentArchiveddocumentCancelledrecipientUpdatedrecipientResetdocumentCreateddocumentFinalPdfCreateddocumentRejectedrecipientSentEmailrecipientVisitingrecipientCompletedrecipientRejectedrecipientEmailOpenedtaskDocumentCreatedtaskCompletedtaskStoppedByRecipientStopListtaskTrialCreditBlockedtaskCreditBlockedtemplateArchivedtemplateUpdatedtemplateElementCreatedtemplateElementUpdatedtemplateElementDeletedtemplateRoleCreatedtemplateRoleUpdatedtemplateRoleDeleteduploadScanneduploadTypeCheckeduploadConvertinguploadFlatteneduploadTagsParseduploadPdfMetaExtracteduploadCompleteduploadFailedcreditUpdated
Αφιερωμένοι οδηγοί ροής εργασίας: