class CalendarLinkGetEvents extends BaseHook implements xi_calendar_link_hook

Properties

SystemTasksController $mod
array $_hook_info

Hook Information "id" => "4914" "instance_id" => "api_microsoft" "name" => "oauth_client" "hook" => "webservice.oauth_client" "type" => "object" "registry_name" => "oauth_client" "function_name" => "" "internal" => "no" "dep_mode" => "local" "active" => "yes" "title" => "Basic functions" "description" => "" "options" => ""

from  BaseHook

Methods

string
getHookDescription()

No description

from  BaseHook
string
getHookIdentifier()

Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name

from  BaseHook
array
getHookInfoValue(bool $key = false)

Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)

from  BaseHook
string
getHookInstance()

No description

from  BaseHook
string
getHookName()

No description

from  BaseHook
string
getHookTitle()

No description

from  BaseHook
getObject()

No description

from  BaseHook
bool|array
get_calendars(int $calendar_id = 0, string $search_term = '')

Get calendars

get_event_by_id($calendar_id, $event_id)

No description

array
get_events(int $calendar_id = null, string $searchterm = null, string $source = 'calendar', null $start_ts = null, null $end_ts = null)

Returns an object collection of event items

bool
isAvailable()

No description

Details

in BaseHook at line 76
string getHookDescription()

No description

Return Value

string

in BaseHook at line 55
string getHookIdentifier()

Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name

Return Value

string

in BaseHook at line 45
array getHookInfoValue(bool $key = false)

Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)

Parameters

bool $key

Return Value

array

in BaseHook at line 69
string getHookInstance()

No description

Return Value

string

in BaseHook at line 62
string getHookName()

No description

Return Value

string

in BaseHook at line 83
string getHookTitle()

No description

Return Value

string

in BaseHook at line 88
getObject()

No description

at line 57
bool|array get_calendars(int $calendar_id = 0, string $search_term = '')

Get calendars

Parameters

int $calendar_id
string $search_term

Return Value

bool|array

at line 67
get_event_by_id($calendar_id, $event_id)

No description

Parameters

$calendar_id
$event_id

at line 30
array get_events(int $calendar_id = null, string $searchterm = null, string $source = 'calendar', null $start_ts = null, null $end_ts = null)

Returns an object collection of event items

Parameters

int $calendar_id
string $searchterm
string $source
null $start_ts
null $end_ts

Return Value

array

at line 119
bool isAvailable()

No description

Return Value

bool