seitime-frappe/frappe/docs/current/api/frappe.defaults.html
Ashish Acharya 3a65d7a1ff Base Code
2015-11-26 20:46:18 +05:30

310 lines
No EOL
8.5 KiB
HTML

<!-- title: frappe.defaults --><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/defaults.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.defaults._clear_cache" href="#frappe.defaults._clear_cache" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.defaults.<b>_clear_cache</b>
<i class="text-muted">(parent)</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.defaults.add_default" href="#frappe.defaults.add_default" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.defaults.<b>add_default</b>
<i class="text-muted">(key, value, parent, parenttype=None)</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.defaults.add_global_default" href="#frappe.defaults.add_global_default" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.defaults.<b>add_global_default</b>
<i class="text-muted">(key, value)</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.defaults.add_user_default" href="#frappe.defaults.add_user_default" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.defaults.<b>add_user_default</b>
<i class="text-muted">(key, value, user=None, parenttype=None)</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.defaults.build_user_permissions" href="#frappe.defaults.build_user_permissions" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.defaults.<b>build_user_permissions</b>
<i class="text-muted">(user)</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.defaults.clear_cache" href="#frappe.defaults.clear_cache" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.defaults.<b>clear_cache</b>
<i class="text-muted">(user=None)</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.defaults.clear_default" href="#frappe.defaults.clear_default" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.defaults.<b>clear_default</b>
<i class="text-muted">(key=None, value=None, parent=None, name=None, parenttype=None)</i>
</p>
<div class="docs-attr-desc"><p>Clear a default value by any of the given parameters and delete caches.</p>
<p><strong>Parameters:</strong></p>
<ul>
<li><strong><code>key</code></strong> - Default key.</li>
<li><strong><code>value</code></strong> - Default value.</li>
<li><strong><code>parent</code></strong> - User name, or <code>__global</code>, <code>__default</code>.</li>
<li><strong><code>name</code></strong> - Default ID.</li>
<li><strong><code>parenttype</code></strong> - Clear defaults table for a particular type e.g. <strong>User</strong>.</li>
</ul>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.defaults.clear_user_default" href="#frappe.defaults.clear_user_default" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.defaults.<b>clear_user_default</b>
<i class="text-muted">(key, user=None)</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.defaults.get_defaults" href="#frappe.defaults.get_defaults" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.defaults.<b>get_defaults</b>
<i class="text-muted">(user=None)</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.defaults.get_defaults_for" href="#frappe.defaults.get_defaults_for" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.defaults.<b>get_defaults_for</b>
<i class="text-muted">(parent=__default)</i>
</p>
<div class="docs-attr-desc"><p>get all defaults</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.defaults.get_global_default" href="#frappe.defaults.get_global_default" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.defaults.<b>get_global_default</b>
<i class="text-muted">(key)</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.defaults.get_user_default" href="#frappe.defaults.get_user_default" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.defaults.<b>get_user_default</b>
<i class="text-muted">(key, user=None)</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.defaults.get_user_default_as_list" href="#frappe.defaults.get_user_default_as_list" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.defaults.<b>get_user_default_as_list</b>
<i class="text-muted">(key, user=None)</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.defaults.get_user_permissions" href="#frappe.defaults.get_user_permissions" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.defaults.<b>get_user_permissions</b>
<i class="text-muted">(user=None)</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.defaults.set_default" href="#frappe.defaults.set_default" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.defaults.<b>set_default</b>
<i class="text-muted">(key, value, parent, parenttype=__default)</i>
</p>
<div class="docs-attr-desc"><p>Override or add a default value.
Adds default value in table <code>tabDefaultValue</code>.</p>
<p><strong>Parameters:</strong></p>
<ul>
<li><strong><code>key</code></strong> - Default key.</li>
<li><strong><code>value</code></strong> - Default value.</li>
<li><strong><code>parent</code></strong> - Usually, <strong>User</strong> to whom the default belongs.</li>
<li><strong><code>parenttype</code></strong> - [optional] default is <code>__default</code>.</li>
</ul>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.defaults.set_global_default" href="#frappe.defaults.set_global_default" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.defaults.<b>set_global_default</b>
<i class="text-muted">(key, value)</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.defaults.set_user_default" href="#frappe.defaults.set_user_default" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.defaults.<b>set_user_default</b>
<i class="text-muted">(key, value, user=None, parenttype=None)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<!-- autodoc -->