Method: Contentstack::Query#include_reference

Defined in:
lib/contentstack/query.rb

#include_reference(reference_field_uids) ⇒ Contentstack::Query

Add a constraint that requires a particular reference key details.

Example

# Include reference of 'category'
@query = @stack.content_type('product').query
@query.include_reference('category')

# Include reference of 'category' and 'reviews'
@query = @stack.content_type('product').query
@query.include_reference(['category', 'reviews'])

Parameters:

  • reference_field_uids (String/Array) —

    Pass string or array of reference fields that must be included in the response

Returns:


485
486
487
 
# File 'lib/contentstack/query.rb', line 485

def include_reference(reference_field_uids)
  self.include(reference_field_uids)
end