Module: Instances
- Included in:
- Content
- Defined in:
- lib/user/content/instances.rb
Instance Method Summary collapse
-
#create_instance(data, options = nil) ⇒ Object
Create instance.
-
#create_instance_version(id, data, options = nil) ⇒ Object
Create instance version.
-
#delete_instance(id) ⇒ Object
Delete instance.
-
#duplicate_instance(id, data) ⇒ Object
Duplicate instance.
-
#get_instance(id, options = nil) ⇒ Object
Get instance.
-
#get_instances(options = nil, use_post = true) ⇒ Object
Get instances.
-
#update_instance(id, data, options = nil) ⇒ Object
Update instance.
Instance Method Details
#create_instance(data, options = nil) ⇒ Object
Create instance.
Create a instance with data.
Parameters
- data
-
(Hash) – Data to be submitted.
Example
data = {
user_id: 1,
slug: "new-instance",
instance_template_id: 1
}
= { fields: 'id,slug' }
@data = @cxf_user.create_instance(data, )
78 79 80 |
# File 'lib/user/content/instances.rb', line 78 def create_instance(data, = nil) @client.raw('post', '/content/instances', , data_transform(data)) end |
#create_instance_version(id, data, options = nil) ⇒ Object
Create instance version.
Create a instance version with data.
Parameters
- id
-
(Integer) – instance id.
- data
-
(Hash) – Data to be submitted.
- options
-
(Hash) – List of Resource Collection Options shown above can be used as parameter.
89 90 91 |
# File 'lib/user/content/instances.rb', line 89 def create_instance_version(id, data, = nil) @client.raw('post', "/content/instances/#{id}/print-version", , data_transform(data)) end |
#delete_instance(id) ⇒ Object
Delete instance.
Delete a instance.
Parameters
- id
-
(Integer) – instance id.
Example
@data = @cxf_user.delete_instance(6)
118 119 120 |
# File 'lib/user/content/instances.rb', line 118 def delete_instance(id) @client.raw('delete', "/content/instances/#{id}") end |
#duplicate_instance(id, data) ⇒ Object
Duplicate instance.
Duplicate a instance.
Parameters
- id
-
(Integer) – instance id.
- data
-
(Hash) – Data to be submitted.
Example
data = { options: [] }
@data = @cxf_user.duplicate_instance(1, data.to_json)
14 15 16 |
# File 'lib/user/content/instances.rb', line 14 def duplicate_instance(id, data) @client.raw('post', "/content/instances/#{id}/duplicate", nil, data) end |
#get_instance(id, options = nil) ⇒ Object
Get instance.
Get a instance info.
Parameters
- id
-
(Integer) – instance id.
- options
-
(Hash) – List of Resource Collection Options shown above can be used as parameter.
First Example
@data = @cxf_user.get_instance(1)
Second Example
= {
fields: 'id, slug'
}
@data = @cxf_user.get_instance(1, )
58 59 60 |
# File 'lib/user/content/instances.rb', line 58 def get_instance(id, = nil) @client.raw('get', "/content/instances/#{id}", ) end |
#get_instances(options = nil, use_post = true) ⇒ Object
Get instances.
Get a collection of instances.
Parameters
- options
-
(Hash) – List of Resource Collection Options shown above can be used as parameter.
- use_post
-
(Boolean) – Variable to determine if the request is by ‘post’ or ‘get’ functions.
First Example
@data = @cxf_user.get_instances
Second Example
= {
fields: 'id, slug'
}
@data = @cxf_user.get_instances()
Third Example
= {
fields: 'id, slug'
}
@data = @cxf_user.get_instances(, true)
39 40 41 |
# File 'lib/user/content/instances.rb', line 39 def get_instances( = nil, use_post = true) get_query_results('/content/instances', , use_post) end |
#update_instance(id, data, options = nil) ⇒ Object
Update instance.
Update a instance info.
Parameters
- id
-
(Integer) – instance id.
- data
-
(Hash) – Data to be submitted.
Example
data = {
user_id: 1,
slug: 'new-instance'
}
@data = @cxf_user.update_instance(5, data)
106 107 108 |
# File 'lib/user/content/instances.rb', line 106 def update_instance(id, data, = nil) @client.raw('put', "/content/instances/#{id}", , data_transform(data)) end |