1. class
  2. XELOS
  3. \
  4. Modules
  5. \
  6. Lists
  7. \
  8. Hook
  9. \
  10. Calendar
  11. \
  12. TimespanGetEvents

TimespanGetEvents

class TimespanGetEvents extends BaseHook implements xi_calendar_link_hook

Class TimespanGetEvents

Properties

ListsController $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
array|null
get_calendars(string $calendar_id = null, string $searchterm = null)

Returns an array of all available calendars

xm_calendar_event_instance|null
get_event_by_id(string $calendar_id, string $event_id)

Return single matching the given event_id

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

Returns an object collection of event items

bool
isAvailable()

Returns true if this hook is available otherwise false.

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
array|null get_calendars(string $calendar_id = null, string $searchterm = null)

Returns an array of all available calendars

Parameters

string $calendar_id

Reflects your internal calendar identification
string $searchterm

If searchterm is specified, this function should only return matching calendars

Return Value

array|null

Example: [['id'=>'my_cal','title'=>'my calendar','source'=>'my_module'],[...]]

at line 117
xm_calendar_event_instance|null get_event_by_id(string $calendar_id, string $event_id)

Return single matching the given event_id

Parameters

string $calendar_id
string $event_id

Return Value

xm_calendar_event_instance|null

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

Returns an object collection of event items

Parameters

string $calendar_id

Reflects your internal calendar identification
string $searchterm

If searchterm is specified, this function should only return matching calendars
string $source

Deprecated - indicates the calling source
int $start_ts

If specified, this function should only return events ending after start_ts
int $end_ts

If specified, this function should only return event starting before end_ts

Return Value

array|null

at line 36
bool isAvailable()

Returns true if this hook is available otherwise false.

Return Value

bool