Folder module

class rohub.Folder.Folder.Folder(ro_id=None, name=None, parent_folder=None, description=None, identifier=None, post_request=True)

Bases: object

Class Representation of Rohub’s folder.

Note

editable attributes:
- name
- ro_id
- parent_folder
- description

read-only attributes:
- identifier
- path
- size
- order
- created
- creator
- modificator
- modified
- created_on
- created_by
- modified
- authors_credits
- contributors_credits
- shared_link
- count
- has_annotations
- api_link

delete()

Function that deletes folder.

Warning

The folder will be deleted from the service and will no longer appear in the API. This doesn’t mean that object created in your local scope will be removed!

Returns: None
Return type: None

show_full_metadata()

Function that shows all metadata associated with the folder.

Returns: response content from the API
Return type: dict

show_metadata()

Function that shows selected (most relevant) information regarding folder.

Returns: folder’s most relevant metadata
Return type: dict

update()

Function for updating folder object in the service.

Note

After executing update_metadata the resource will be updated in the service with accordance to the changes that were made to the python object in your local scope.

Returns: response content from the API
Return type: dict