Frends.Salesforce.PubSubConsume / 1.1.0

Summary

Consumes events from a Pub/Sub topic and returns the position it reached, which can be fed back on the next run so consumption resumes rather than restarting.

Typical use — near-real-time replication out of Salesforce, where storing the returned position between runs is what stops events being missed or repeated

Details

Frends version: 5.7 and newer
Agent: Crossplatform
Target framework: net8.0

Essential parameters.

Name	Type	Default	Example	Description
TopicName	`String`	–	`/event/My_Event__e`	Salesforce topic name to subscribe to e.g., /event/My_Event__e or /data/AccountChangeEvent.
NumberOfEvents	`Int32`	`1`	`10`	Maximum number of events to receive before the task returns.
ReplayPreset	`ReplayPresetOption`	`Latest`	`Latest`	Replay the starting point for the subscription. Possible values: `Latest`: Start from the tip of the stream. `Earliest`: Start from the oldest retained event in the stream. `Custom`: Start after a custom replay ID.
ReplayIdBase64	`String`	–	`AAABBBCCC==`	Base64 encoded replay ID to continue from when ReplayPreset is Custom.
WaitTimeoutSeconds	`Int32`	`30`	`30`	Maximum time to wait for events before returning. Use 0 to wait infinite or until the Frends cancellation token cancels the task.