Menu

pycaravel: This module is designed to simplify continuous integration (CI) of data from multiple projects.

Note

This page is a reference documentation. It only explains the class signature, and not how to use it. Please refer to the gallery for the big picture.

class caravel.nextcloud.api_wrappers.share.Share(requester)[source]
create_share(path, share_type, share_with=None, public_upload=None, password=None, permissions=None)[source]

Share a file/folder with a user/group or as public link.

Mandatory fields: share_type, path and share_with for share_type USER (0) or GROUP (1).

delete_share(sid)[source]

Remove the given share.

get_share_info(sid)[source]

Get information about a given share.

get_shares()[source]

Get all shares from the user.

get_shares_from_path(path, reshares=None, subfiles=None)[source]

Get all shares from a given file/folder.

update_share(sid, permissions=None, password=None, public_upload=None, expire_date='')[source]

Update a given share, only one value can be updated per request.

static validate_share_parameters(path, share_type, share_with)[source]

Check if share parameters make sense.

Follow us

© 2025, Antoine Grigis