Streaming API Developer Guide

Getting Started with Streaming API
Code Examples
Client Connection Considerations
PushTopic Events
Working with PushTopics
PushTopic Queries
Event Notification Rules
Events
Notifications
NotifyForFields Set to All
NotifyForFields Set to Referenced
NotifyForFields Set to Select
NotifyForFields Set to Where
Notification Scenarios
Replay PushTopic Streaming Events
Filtered Subscriptions
Bulk Subscriptions
Deactivating a Push Topic
PushTopic Considerations
PushTopic Streaming Allocations
Reference: PushTopic
Generic Events
Monitoring Event Usage
PDF

Newer Version Available

This content describes an older version of this product. View Latest

NotifyForFields Set to Referenced

When you set the value of PushTopic.NotifyForFields to Referenced, a change to any field value in the record as long as that field is referenced in the query SELECT clause or WHERE clause causes the Streaming API matching logic to evaluate the record to determine whether to generate a notification.

If the PushTopic.NotifyForFields value is Referenced, the PushTopic query must have a SELECT clause with at least one field other than ID or a WHERE clause with at least one field other than Id.

Event A notification is generated when
Record is created The record field values match the values specified in the WHERE clause.
Record is updated

The following conditions are met.

  • A change occurs in one or more record fields that are specified in the PushTopic query SELECT or WHERE clause.
  • For fields specified in the WHERE clause, all record field values match the values in the WHERE clause.

Examples

PushTopic Query Result
SELECT Id, f1, f2, f3 FROM Invoice_Statement__c Generates a notification if f1, f2, or f3 have changed.
SELECT Id, f1, f2 FROM Invoice_Statement__c WHERE f3 = 'abc' AND f4 LIKE 'xyz' Generates a notification if f1, f2, f3, or f4 have changed and f3 and f4 match the values in the WHERE clause.
SELECT Id FROM Invoice_Statement__c WHERE f3 = 'abc' AND f4 LIKE 'xyz' Generates a notification if f3 and f4 have changed and f3 and f4 match the values in the WHERE clause.
SELECT Id, f1, f2 FROM Invoice_Statement__c WHERE Id IN ('a07B0000000KWZ7IAO', 'e10R0000000KEU9IAO', 'v32B0000000KWZ7YEP') Generates a notification if f1 or f2 have changed and the record ID is contained in the WHERE clause IN list.
SELECT Id, f1, f2 FROM Invoice_Statement__c WHERE f3 = 'abc' AND f4 LIKE 'xyz' AND Id IN ('a07B0000000KWZ7IAO', 'e10R0000000KEU9IAO', 'v32B0000000KWZ7YEP') Generates a notification if f1, f2, f3, or f4 have changed, f3 and f4 match the values in the WHERE clause, and the ID is contained in the WHERE clause IN list.