SyncAdapter
Table of Contents
Methods
- deleteEvent() : true
- Deletes calendar event
- getEventList() : array<string|int, mixed>
- Returns calendar events for given section.
- getSectionList() : array<string|int, mixed>
- Returns collection of sections for user or other entity.
- getTaskList() : array<string|int, mixed>
- Returns calendar events.
Methods
deleteEvent()
Deletes calendar event
public
static deleteEvent(int $eventId[, array<string|int, mixed> $params = [] ]) : true
Parameters
- $eventId : int
-
- id of the event.
- $params : array<string|int, mixed> = []
-
contains additional information.
Return values
true —or false - result of the operation
getEventList()
Returns calendar events for given section.
public
static getEventList([string $sectionId = false ][, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
- $sectionId : string = false
-
id of section (collection) to select events from.
- $params : array<string|int, mixed> = []
-
additional params.
Return values
array<string|int, mixed> —list of calendar events
getSectionList()
Returns collection of sections for user or other entity.
public
static getSectionList(string $entityType, int $entityId[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
- $entityType : string
-
entity type (example: 'user' for user's calendars).
- $entityId : int
-
id of entity.
- $params : array<string|int, mixed> = []
-
additional params.
Return values
array<string|int, mixed> —list of calendar sections
getTaskList()
Returns calendar events.
public
static getTaskList(string $userId[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
- $userId : string
-
user id
- $params : array<string|int, mixed> = []
-
additional params.
Return values
array<string|int, mixed> —list of tasks prepared for viewing in calendar view