Get calendar event for User
@param number $user_id id of the user
@return array|mixed
Arguments
| user_id |
numeric |
| client_id |
numeric |
| time |
array |
| calendars |
alpha_num |
get Events by calendar id
@return array|mixed|string
Arguments
| calendar_id |
numeric, required |
Add new calendar event
@return array|mixed
@params calendar_id is the id from
CalendarController
Arguments
| calendar_id |
numeric, required |
| created_by_user_id |
numeric |
| assigned_to_user_id |
numeric |
| company_id |
numeric |
| type |
in: event, task |
| name |
max:100, required |
| date |
date, required |
| day_of_week |
numeric |
| all_day |
numeric |
| repeat_status |
numeric |
| repeat_interval |
in: daily, weekly, monthly, yearly, |
| repeat_every |
numeric |
| start_time |
string |
| end_time |
string |
| repeat_start |
string |
| repeat_end |
string |
| latitude |
string |
| longitude |
string |
| description |
max:65535 |
| color |
max:7 |
| privacy |
in: public, private |
| priority |
numeric |
| percent_complete |
numeric |
| completed |
string |
| busy |
numeric |
| action |
in: audio, display, procedure |
| status |
in: cancelled, confirmed, tentative, needs-action, completed, in-process |
| location |
regex:/^[\p{L}-\s\.\, \/\_\-\+\=0-9&]+/ui, max:255 |
| events_in_utc |
boolean |
Add new calendar events
@return array|mixed
Arguments
Get event by id
@return array|mixed
Arguments
Update calendar event
@return array|mixed
@params calendar_id is the id from
CalendarController
Arguments
| id |
numeric, required |
| calendar_id |
numeric, required |
| created_by_user_id |
numeric |
| assigned_to_user_id |
numeric |
| company_id |
numeric |
| type |
alpha_dash |
| name |
string, max:100 |
| day_of_week |
numeric |
| date |
date |
| all_day |
numeric |
| repeat_status |
numeric |
| repeat_interval |
alpha_dash |
| repeat_every |
numeric |
| start_time |
string |
| end_time |
string |
| latitude |
string |
| longitude |
string |
| description |
max:65535 |
| color |
max:7 |
| privacy |
alpha_dash |
| priority |
numeric |
| percent_complete |
numeric |
| completed |
between:0, 100 |
| busy |
numeric |
| action |
alpha_dash |
| status |
alpha_dash |
| location |
regex:/^[\p{L}-\s\.\, \/\_\-\+\=0-9&]+/ui, max:255 |
Delete calendar event
@return array|mixed
Arguments
Share calendar event with Client or User
@return array|mixed
Arguments
| id |
numeric, required |
| user_id |
numeric |
| client_id |
numeric |
Update sharing properties
@return array|mixed
Arguments
| id |
numeric, required |
| user_id |
numeric |
| client_id |
numeric |
| attendees_rights |
numeric |
| confirmation_needed |
boolean |
Unshare calendar event with Client or User
@return array|mixed
Arguments
| id |
numeric, required |
| user_id |
numeric |
| client_id |
numeric |
Get all records with pagination.
The function accepts limit and has a maximum limit that can not be overwritten
@return
Data Table object
Arguments
Get all records
this function returns all the records. Pagination / limit are not accepted
@return
Data Table object
Arguments
Get Change Log for an object
Arguments
Function for adding / editing a record with all the children
@params children is an array of records that has the same rules as add() or set().
@param id is always required - if it is not integer, the child will be added. If it is an integer, the child with the same id will be updated
Ex.:
id => 3 #updates the id 3 of the parent class
.....
children => [
1 => [....]
'new' => [....]
]
This will:
- update the id=3 for the parent class with all the values included,
- it will update the child with id=1
- will add a new child (new)
- if delete is allowed, all other possible children will be removed
@params id - is always required, if it is not integer, the record will be added, else it will be updated
@params id : This method will inset/edit a record with the given id in
CalendarController
with children in the current class
Missing children in the argument will
be DELETED!
Arguments
| dataTableMethod |
string, required |
| sDatatableKey |
string |