Πήγαινε στο κύριο περιεχόμενο

Χρήση Συνδρομών

Οι συνδρομές είναι χρήσιμες για πραγματικό χρόνο 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

Αντιπροσωπευτικά Ονόματα Γεγονότων

Συνηθισμένα ονόματα γεγονότων περιλαμβάνουν:

  • documentArchived
  • documentCancelled
  • recipientUpdated
  • recipientReset
  • documentCreated
  • documentFinalPdfCreated
  • documentRejected
  • recipientSentEmail
  • recipientVisiting
  • recipientCompleted
  • recipientRejected
  • recipientEmailOpened
  • taskDocumentCreated
  • taskCompleted
  • taskStoppedByRecipientStopList
  • taskTrialCreditBlocked
  • taskCreditBlocked
  • templateArchived
  • templateUpdated
  • templateElementCreated
  • templateElementUpdated
  • templateElementDeleted
  • templateRoleCreated
  • templateRoleUpdated
  • templateRoleDeleted
  • uploadScanned
  • uploadTypeChecked
  • uploadConverting
  • uploadFlattened
  • uploadTagsParsed
  • uploadPdfMetaExtracted
  • uploadCompleted
  • uploadFailed
  • creditUpdated

Αφιερωμένοι οδηγοί ροής εργασίας: