Module: RegApi2::Folder
Overview
REG.API folder category
Instance Method Summary collapse
-
#add_services(opts = {}) ⇒ Object
Use this function to add services to folders.
-
#create(opts = {}) ⇒ void
Creates a folder.
-
#get_services(opts = {}) ⇒ Object
Use this function to obtain the list of services available in the folder.
-
#move_services(opts = {}) ⇒ Object
Use this function to move service between folders.
-
#nop(opts = {}) ⇒ Hash(id, name)
You can use this test function to check the availability of folders.
-
#remove(opts = {}) ⇒ void
Removes a folder.
-
#remove_services(opts = {}) ⇒ Object
Use this function to delete services from folders.
-
#rename(opts = {}) ⇒ Hash(folder_content)
Renames a folder.
-
#replace_services(opts = {}) ⇒ Object
This function allows replacement of services already available in a folder with other services (deletes the service available in the folder and adds the services defined by the domain_name or service_id parameter).
Methods included from Builder
Instance Method Details
#add_services(opts = {}) ⇒ Object
Use this function to add services to folders.
68 |
# File 'lib/reg_api2/folder.rb', line 68 define :add_services |
#create(opts = {}) ⇒ void
Support of service lists: no
This method returns an undefined value.
Creates a folder.
31 |
# File 'lib/reg_api2/folder.rb', line 31 define :create, required: %w[ folder_name ] |
#get_services(opts = {}) ⇒ Object
Use this function to obtain the list of services available in the folder.
63 |
# File 'lib/reg_api2/folder.rb', line 63 define :get_services |
#move_services(opts = {}) ⇒ Object
Use this function to move service between folders.
83 |
# File 'lib/reg_api2/folder.rb', line 83 define :move_services |
#nop(opts = {}) ⇒ Hash(id, name)
Support of service lists: no
You can use this test function to check the availability of folders.
21 |
# File 'lib/reg_api2/folder.rb', line 21 define :nop |
#remove(opts = {}) ⇒ void
Support of service lists: no
This method returns an undefined value.
Removes a folder.
44 |
# File 'lib/reg_api2/folder.rb', line 44 define :remove |
#remove_services(opts = {}) ⇒ Object
Use this function to delete services from folders.
73 |
# File 'lib/reg_api2/folder.rb', line 73 define :remove_services |
#rename(opts = {}) ⇒ Hash(folder_content)
Support of service lists: no
Renames a folder.
58 |
# File 'lib/reg_api2/folder.rb', line 58 define :rename, required: %w[ new_folder_name ] |
#replace_services(opts = {}) ⇒ Object
This function allows replacement of services already available in a folder with other services (deletes the service available in the folder and adds the services defined by the domain_name or service_id parameter).
78 |
# File 'lib/reg_api2/folder.rb', line 78 define :replace_services |