536 lines
No EOL
12 KiB
HTML
536 lines
No EOL
12 KiB
HTML
<!-- title: Event -->
|
|
|
|
|
|
|
|
|
|
|
|
<div class="dev-header">
|
|
|
|
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
|
|
Version 6.x.x</a>
|
|
|
|
|
|
<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/tree/develop/frappe/desk/doctype/event"
|
|
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<p><b>Table Name:</b> <code>tabEvent</code></p>
|
|
|
|
|
|
|
|
|
|
<h3>Fields</h3>
|
|
|
|
<table class="table table-bordered" style="table-layout: fixed;">
|
|
<thead>
|
|
<tr>
|
|
<th style="width: 5%">Sr</th>
|
|
<th style="width: 25%">Fieldname</th>
|
|
<th style="width: 20%">Type</th>
|
|
<th style="width: 25%">Label</th>
|
|
<th style="width: 25%">Options</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr class="info">
|
|
<td>1</td>
|
|
<td ><code>details</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>2</td>
|
|
<td class="danger" title="Mandatory"><code>subject</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Subject
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>3</td>
|
|
<td class="danger" title="Mandatory"><code>event_type</code></td>
|
|
<td >
|
|
Select</td>
|
|
<td >
|
|
Event Type
|
|
|
|
</td>
|
|
<td>
|
|
<pre>Private
|
|
Public
|
|
Cancel</pre>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>4</td>
|
|
<td ><code>send_reminder</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Send an email reminder in the morning
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>5</td>
|
|
<td ><code>column_break_4</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>6</td>
|
|
<td class="danger" title="Mandatory"><code>starts_on</code></td>
|
|
<td >
|
|
Datetime</td>
|
|
<td >
|
|
Starts on
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>7</td>
|
|
<td ><code>ends_on</code></td>
|
|
<td >
|
|
Datetime</td>
|
|
<td >
|
|
Ends on
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>8</td>
|
|
<td ><code>all_day</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
All Day
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>9</td>
|
|
<td ><code>section_break_8</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>10</td>
|
|
<td ><code>repeat_this_event</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Repeat this Event
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>11</td>
|
|
<td ><code>section_break_11</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>12</td>
|
|
<td ><code>repeat_on</code></td>
|
|
<td >
|
|
Select</td>
|
|
<td >
|
|
Repeat On
|
|
|
|
</td>
|
|
<td>
|
|
<pre>
|
|
Every Day
|
|
Every Week
|
|
Every Month
|
|
Every Year</pre>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>13</td>
|
|
<td ><code>repeat_till</code></td>
|
|
<td >
|
|
Date</td>
|
|
<td >
|
|
Repeat Till
|
|
<p class="text-muted small">
|
|
Leave blank to repeat always</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>14</td>
|
|
<td ><code>column_break_11</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>15</td>
|
|
<td ><code>monday</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Monday
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>16</td>
|
|
<td ><code>tuesday</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Tuesday
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>17</td>
|
|
<td ><code>wednesday</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Wednesday
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>18</td>
|
|
<td ><code>thursday</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Thursday
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>19</td>
|
|
<td ><code>friday</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Friday
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>20</td>
|
|
<td ><code>saturday</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Saturday
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>21</td>
|
|
<td ><code>sunday</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Sunday
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>22</td>
|
|
<td ><code>section_break_6</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>23</td>
|
|
<td ><code>description</code></td>
|
|
<td >
|
|
Text Editor</td>
|
|
<td >
|
|
Description
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>24</td>
|
|
<td ><code>participants</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Participants
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>25</td>
|
|
<td ><code>groups</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
Groups
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>26</td>
|
|
<td ><code>roles</code></td>
|
|
<td >
|
|
Table</td>
|
|
<td >
|
|
Roles
|
|
|
|
</td>
|
|
<td>
|
|
|
|
|
|
|
|
|
|
<a href="https://frappe.github.io/frappe/current/models/desk/event_role">Event Role</a>
|
|
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>27</td>
|
|
<td ><code>ref_type</code></td>
|
|
<td >
|
|
Link</td>
|
|
<td >
|
|
Ref Type
|
|
|
|
</td>
|
|
<td>
|
|
|
|
|
|
|
|
|
|
<a href="https://frappe.github.io/frappe/current/models/core/doctype">DocType</a>
|
|
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>28</td>
|
|
<td ><code>ref_name</code></td>
|
|
<td >
|
|
Dynamic Link</td>
|
|
<td >
|
|
Ref Name
|
|
|
|
</td>
|
|
<td>
|
|
<pre>ref_type</pre>
|
|
</td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<hr>
|
|
<h3>Controller</h3>
|
|
<h4>frappe.desk.doctype.event.event</h4>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 style="font-weight: normal;">Class <b>Event</b></h3>
|
|
|
|
<p style="padding-left: 30px;"><i>Inherits from frappe.model.document.Document</i></h4>
|
|
|
|
<div class="docs-attr-desc"><p></p>
|
|
</div>
|
|
<div style="padding-left: 30px;">
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="get_route" href="#get_route" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>get_route</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>for test-case</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="validate" href="#validate" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>validate</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
</div>
|
|
<hr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/frappe.desk.doctype.event.event.get_events</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.desk.doctype.event.event.get_events" href="#frappe.desk.doctype.event.event.get_events" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.desk.doctype.event.event.<b>get_events</b>
|
|
<i class="text-muted">(start, end, user=None, for_reminder=False)</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.desk.doctype.event.event.get_permission_query_conditions" href="#frappe.desk.doctype.event.event.get_permission_query_conditions" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.desk.doctype.event.event.<b>get_permission_query_conditions</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.desk.doctype.event.event.has_permission" href="#frappe.desk.doctype.event.event.has_permission" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.desk.doctype.event.event.<b>has_permission</b>
|
|
<i class="text-muted">(doc, 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.desk.doctype.event.event.send_event_digest" href="#frappe.desk.doctype.event.event.send_event_digest" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.desk.doctype.event.event.<b>send_event_digest</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- autodoc -->
|
|
<!-- jinja -->
|
|
<!-- static --> |