Module: Contentful::Management::Resource::Archiver

Included in:
Asset, Entry
Defined in:
lib/contentful/management/resource/archiver.rb

Overview

Wrapper for Resources with /archived API

Instance Method Summary collapse

Instance Method Details

#archive ⇒ Contentful::Management::Resource

Archives a resource.

Returns:



9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/contentful/management/resource/archiver.rb', line 9

def archive
  ResourceRequester.new(client, self.class).archive(
    self,
    {
      space_id: space.id,
      environment_id: environment_id,
      resource_id: id,
      suffix: '/archived'
    },
    version: sys[:version]
  )
end

#archived? ⇒ Boolean

Checks if a resource is archived.

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/contentful/management/resource/archiver.rb', line 41

def archived?
  sys[:archivedAt] ? true : false
end

#unarchive ⇒ Contentful::Management::Resource

Unarchives a resource.

Returns:



25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/contentful/management/resource/archiver.rb', line 25

def unarchive
  ResourceRequester.new(client, self.class).unarchive(
    self,
    {
      space_id: space.id,
      environment_id: environment_id,
      resource_id: id,
      suffix: '/archived'
    },
    version: sys[:version]
  )
end