64 lines
No EOL
2 KiB
HTML
64 lines
No EOL
2 KiB
HTML
<!-- title: frappe.desk.star --><div class="dev-header">
|
|
|
|
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
|
|
Version 6.6.5</a>
|
|
|
|
|
|
<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/desk/star.py"
|
|
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.desk.star._toggle_star" href="#frappe.desk.star._toggle_star" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.desk.star.<b>_toggle_star</b>
|
|
<i class="text-muted">(doctype, name, add=False, user=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Same as toggle_star but hides param <code>user</code> from API</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/frappe.desk.star.toggle_star</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.desk.star.toggle_star" href="#frappe.desk.star.toggle_star" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.desk.star.<b>toggle_star</b>
|
|
<i class="text-muted">(doctype, name, add=False)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Adds / removes the current user in the <code>__starred_by</code> property of the given document.
|
|
If column does not exist, will add it in the database.</p>
|
|
|
|
<p>The <code>_starred_by</code> property is always set from this function and is ignored if set via
|
|
Document API</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>doctype</code></strong> - DocType of the document to star</li>
|
|
<li><strong><code>name</code></strong> - Name of the document to star</li>
|
|
<li><strong><code>add</code></strong> - <code>Yes</code> if star is to be added. If not <code>Yes</code> the star will be removed.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- autodoc --> |