160 lines
No EOL
4.5 KiB
HTML
160 lines
No EOL
4.5 KiB
HTML
<!-- title: frappe.share --><div class="dev-header">
|
|
|
|
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
|
|
Version 6.10.1</a>
|
|
|
|
|
|
<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/share.py"
|
|
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/frappe.share.add</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.share.add" href="#frappe.share.add" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.share.<b>add</b>
|
|
<i class="text-muted">(doctype, name, user=None, read=1, write=0, share=0, everyone=0, flags=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Share the given document with a user.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.share.check_share_permission" href="#frappe.share.check_share_permission" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.share.<b>check_share_permission</b>
|
|
<i class="text-muted">(doctype, name)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Check if the user can share with other users</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.share.get_share_name" href="#frappe.share.get_share_name" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.share.<b>get_share_name</b>
|
|
<i class="text-muted">(doctype, name, user, everyone)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.share.get_shared" href="#frappe.share.get_shared" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.share.<b>get_shared</b>
|
|
<i class="text-muted">(doctype, user=None, rights=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Get list of shared document names for given user and DocType.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>doctype</code></strong> - DocType of which shared names are queried.</li>
|
|
<li><strong><code>user</code></strong> - User for which shared names are queried.</li>
|
|
<li><strong><code>rights</code></strong> - List of rights for which the document is shared. List of <code>read</code>, <code>write</code>, <code>share</code></li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.share.get_shared_doctypes" href="#frappe.share.get_shared_doctypes" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.share.<b>get_shared_doctypes</b>
|
|
<i class="text-muted">(user=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Return list of doctypes in which documents are shared for the given user.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/frappe.share.get_users</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.share.get_users" href="#frappe.share.get_users" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.share.<b>get_users</b>
|
|
<i class="text-muted">(doctype, name, fields=*)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Get list of users with which this document is shared</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.share.remove" href="#frappe.share.remove" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.share.<b>remove</b>
|
|
<i class="text-muted">(doctype, name, user, flags=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/frappe.share.set_permission</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.share.set_permission" href="#frappe.share.set_permission" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.share.<b>set_permission</b>
|
|
<i class="text-muted">(doctype, name, user, permission_to, value=1, everyone=0)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Set share permission.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- autodoc --> |