Module: Contentful::Management::Resource
- Included in:
- ApiKey, Array, Asset, ContentType, EditorInterface, Entry, Field, File, Link, Locale, Location, Role, Snapshot, Space, Validation, Webhook
- Defined in:
- lib/contentful/management/resource.rb,
lib/contentful/management/resource/fields.rb,
lib/contentful/management/resource/archiver.rb,
lib/contentful/management/resource/publisher.rb,
lib/contentful/management/resource/refresher.rb,
lib/contentful/management/resource/array_like.rb,
lib/contentful/management/resource/field_aware.rb,
lib/contentful/management/resource/asset_fields.rb,
lib/contentful/management/resource/entry_fields.rb,
lib/contentful/management/resource/all_published.rb,
lib/contentful/management/resource/system_properties.rb
Overview
Include this module to declare a class to be a contentful resource. This is done by the default in the existing resource classes
You can define your own classes that behave like contentful resources: See examples/custom_classes.rb to see how.
Take a look at examples/resource_mapping.rb on how to register them to be returned by the client by default
Defined Under Namespace
Modules: AllPublished, Archiver, ArrayLike, AssetFields, ClassMethods, EntryFields, FieldAware, Fields, Publisher, Refresher, SystemProperties
Instance Attribute Summary collapse
-
#client ⇒ Object
Shared instance of the API client.
-
#default_locale ⇒ Object
readonly
rubocop:enable Style/DoubleNegation.
-
#properties ⇒ Object
readonly
rubocop:enable Style/DoubleNegation.
-
#raw_object ⇒ Object
readonly
rubocop:enable Style/DoubleNegation.
-
#request ⇒ Object
readonly
rubocop:enable Style/DoubleNegation.
Instance Method Summary collapse
-
#array? ⇒ Boolean
Returns true for resources that behave like an array.
-
#destroy ⇒ true, Contentful::Management::Error
Destroys a resource.
-
#fields ⇒ Object
Resources that don’t include Fields or AssetFields return nil for #fields.
-
#nested_locale_fields? ⇒ Boolean
By default, fields come flattened in the current locale.
- #resource? ⇒ true
-
#sys ⇒ Object
Resources that don’t include SystemProperties return nil for #sys.
-
#update(attributes) ⇒ Contentful::Management::Resource
Updates a resource.
Instance Attribute Details
#client ⇒ Object
Shared instance of the API client
105 106 107 |
# File 'lib/contentful/management/resource.rb', line 105 def client @client end |
#default_locale ⇒ Object (readonly)
rubocop:enable Style/DoubleNegation
30 31 32 |
# File 'lib/contentful/management/resource.rb', line 30 def default_locale @default_locale end |
#properties ⇒ Object (readonly)
rubocop:enable Style/DoubleNegation
30 31 32 |
# File 'lib/contentful/management/resource.rb', line 30 def properties @properties end |
#raw_object ⇒ Object (readonly)
rubocop:enable Style/DoubleNegation
30 31 32 |
# File 'lib/contentful/management/resource.rb', line 30 def raw_object @raw_object end |
#request ⇒ Object (readonly)
rubocop:enable Style/DoubleNegation
30 31 32 |
# File 'lib/contentful/management/resource.rb', line 30 def request @request end |
Instance Method Details
#array? ⇒ Boolean
Returns true for resources that behave like an array
83 84 85 |
# File 'lib/contentful/management/resource.rb', line 83 def array? false end |
#destroy ⇒ true, Contentful::Management::Error
Destroys a resource.
72 73 74 |
# File 'lib/contentful/management/resource.rb', line 72 def destroy ResourceRequester.new(client, self.class).destroy(space_id: space.id, resource_id: id) end |
#fields ⇒ Object
Resources that don’t include Fields or AssetFields return nil for #fields
100 101 102 |
# File 'lib/contentful/management/resource.rb', line 100 def fields nil end |
#nested_locale_fields? ⇒ Boolean
By default, fields come flattened in the current locale. This is different for syncs
88 89 90 91 92 |
# File 'lib/contentful/management/resource.rb', line 88 def nested_locale_fields? # rubocop:disable Style/DoubleNegation !!@nested_locale_fields # rubocop:enable Style/DoubleNegation end |
#resource? ⇒ true
110 111 112 |
# File 'lib/contentful/management/resource.rb', line 110 def resource? true end |
#sys ⇒ Object
Resources that don’t include SystemProperties return nil for #sys
95 96 97 |
# File 'lib/contentful/management/resource.rb', line 95 def sys nil end |
#update(attributes) ⇒ Contentful::Management::Resource
Updates a resource.
60 61 62 63 64 65 66 67 |
# File 'lib/contentful/management/resource.rb', line 60 def update(attributes) ResourceRequester.new(client, self.class).update( self, { space_id: space.id, resource_id: id }, query_attributes(attributes), version: sys[:version] ) end |