Version 6.x.x Source

Public API
/api/method/frappe.share.add

frappe.share.add (doctype, name, user=None, read=1, write=0, share=0, everyone=0, flags=None)

Share the given document with a user.


frappe.share.check_share_permission (doctype, name)

Check if the user can share with other users


frappe.share.get_share_name (doctype, name, user, everyone)

No docs


frappe.share.get_shared (doctype, user=None, rights=None)

Get list of shared document names for given user and DocType.

Parameters:


frappe.share.get_shared_doctypes (user=None)

Return list of doctypes in which documents are shared for the given user.


Public API
/api/method/frappe.share.get_users

frappe.share.get_users (doctype, name, fields=*)

Get list of users with which this document is shared


frappe.share.remove (doctype, name, user, flags=None)

No docs


Public API
/api/method/frappe.share.set_permission

frappe.share.set_permission (doctype, name, user, permission_to, value=1, everyone=0)

Set share permission.