Defnyddio Tanysgrifiadau

Mae tanysgrifiadau yn ddefnyddiol ar gyfer profiad defnyddiwr amser-real megis:

• cynnydd llwytho i fyny
• cynnydd tasg asyncronig
• diweddariadau cylch bywyd dogfen a derbynnydd
• newidiadau credyd

Am y Schema llwyth (payload) ei hun, gweler:

• Connect to AppSync Subscriptions
• Subscription Event Format
• Subscription Event Schema

Dadansoddi'r Llwyth Digwyddiad Mewnol

Mae maes y tanysgrifiad yn dychwelyd:

• lapio dosbarthu (userId neu groupId)
• llinyn JSON yn data

Bob amser dadansoddwch y gwerth data mewnol cyn delio gyda’r digwyddiad.

const parseEnvelope = (payload) => {
  const raw = payload?.data;
  if (!raw) return null;
  return typeof raw === 'string' ? JSON.parse(raw) : raw;
};

Llwybru yn ôl category a event

Trin:

• category fel teulu’r digwyddiad
• event fel yr action penodol neu gyflwr y llifoedd gwaith

Enghreifftiau:

• category: "upload", event: "uploadCompleted"
• category: "task", event: "taskCreditBlocked"
• category: "documentLifecycle", event: "documentCreated"
• category: "recipientLifecycle", event: "recipientVisiting"

Rheolau Dosbarthu

• defnyddir subscribeUserFeed ar gyfer digwyddiadau wedi’u targedu at ddefnyddwyr megis cynnydd llwytho i fyny a rhai ffandio cylch bywyd.
• defnyddir subscribeGroupFeed ar gyfer digwyddiadau wedi’u targedu at grwpiau megis diweddariadau dogfen, derbynnydd, templed, tasg, credyd a chylch bywyd.
• mae rhai digwyddiadau’n cael eu ffandio i’r ddau gyflenwad gyda’r un eventId.

Canllawiau Cydnawsedd

Os ydych yn fudo o’r data tanysgrifio hen strwythur lflat:

• dadansoddwch gyntaf lapio data mewnol
• symudwch lwyth y digwyddiad i event yn lle systemMessage hen
• defnyddiwch category i benderfynu sut i ddehongli data
• parhewch i anwybyddu meysydd data anhysbys

Enwau Digwyddiad Cynrychioliadol

Mae enwau digwyddiadau cyffredin yn cynnwys:

• 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

Canllawiau llifoedd gwaith penodol:

• Track Upload Progress with Subscriptions
• Track Send Tasks with Subscriptions
• Track Document and Recipient Lifecycle with Subscriptions