Class CApiCalendarManager

CApiCalendarManager class summary

AApiManagerWithStorage

CApiCalendarManager

Package: Calendar
Located at calendar/manager.php

Methods summary

`public`	# `__construct( CApiGlobalManager & $oManager, $sForcedStorage = '' )` Parameters `$oManager` $oManager `$sForcedStorage`
`public boolean`	# `getCalendarAccess( CAccount $oAccount, string $sCalendarId )` Determines whether read/write or read-only permissions are set for accessing calendar from this account. Determines whether read/write or read-only permissions are set for accessing calendar from this account. Parameters `$oAccount` Account object `$sCalendarId` Calendar ID Returns boolean ECalendarPermission::Write or ECalendarPermission::Read accordingly.
`public CAccount\|false`	# `getTenantAccount( CAccount $oAccount )` Parameters `$oAccount` Returns `CAccount`\|false $oAccount
`public CCalendar\|false`	# `getPublicCalendarByHash( string $sHash )` Parameters `$sHash` Returns `CCalendar`\|false $oCalendar
`public CCalendar\|false`	# `getPublicCalendar( string $sCalendarId )` Parameters `$sCalendarId` Returns `CCalendar`\|false $oCalendar
`public CCalendar\|false`	# `getCalendar( CAccount $oAccount, string $sCalendarId )` Loads calendar. Loads calendar. Parameters `$oAccount` Account object `$sCalendarId` Calendar ID Returns `CCalendar`\|false $oCalendar
`public CCalendar`	# `populateCalendarShares( CAccount $oAccount, CCalendar $oCalendar )` Parameters `$oAccount` `$oCalendar` Returns `CCalendar` $oCalendar
`public string\|false`	# `getPublicCalendarHash( string $sCalendarId )` Parameters `$sCalendarId` Returns string\|false
`public array\|boolean`	# `getCalendarUsers( CAccount $oAccount, CCalendar $oCalendar )` (Aurora only) Returns list of user account the calendar was shared with. (Aurora only) Returns list of user account the calendar was shared with. Parameters `$oAccount` Account object `$oCalendar` Calendar object Returns array\|boolean
`public string\|boolean`	# `getPublicUser( )` Returns string\|boolean
`public string\|boolean`	# `getTenantUser( CAccount $oAccount )` Parameters `$oAccount` Returns string\|boolean
`public CAccount\|false`	# `getPublicAccount( )` Returns `CAccount`\|false $oAccount
`public array`	# `getUserCalendars( CAccount $oAccount )` Returns list of calendars for the account. Returns list of calendars for the account. Parameters `$oAccount` Account object Returns array
`public integer`	# `___qSortCallback( array $a, array $b )` Parameters `$a` `$b` Returns integer
`public CCalendar\|false`	# `createCalendar( CAccount $oAccount, string $sName, string $sDescription, integer $iOrder, string $sColor )` Creates new calendar. Creates new calendar. Parameters `$oAccount` Account object `$sName` Name of the calendar `$sDescription` Description of the calendar `$iOrder` Ordinal number of the calendar in calendars list `$sColor` Color code Returns `CCalendar`\|false
`public CCalendar\|false`	# `updateCalendar( CAccount $oAccount, string $sCalendarId, string $sName, string $sDescription, integer $iOrder, string $sColor )` Updates calendar properties. Updates calendar properties. Parameters `$oAccount` Account object `$sCalendarId` Calendar ID `$sName` Name of the calendar `$sDescription` Description of the calendar `$iOrder` Ordinal number of the calendar in calendars list `$sColor` Color code Returns `CCalendar`\|false
`public boolean`	# `updateCalendarVisible( string $sCalendarId, integer $iVisible )` Parameters `$sCalendarId` `$iVisible` Returns boolean
`public boolean`	# `updateCalendarColor( CAccount $oAccount, string $sCalendarId, string $sColor )` Change color of the calendar. Change color of the calendar. Parameters `$oAccount` Account object `$sCalendarId` Calendar ID `$sColor` New color code Returns boolean
`public boolean`	# `deleteCalendar( CAccount $oAccount, string $sCalendarId )` Deletes calendar. Deletes calendar. Parameters `$oAccount` Account object `$sCalendarId` Calendar ID Returns boolean
`public boolean`	# `unsubscribeCalendar( CAccount $oAccount, string $sCalendarId )` Removes calendar from list of those shared with the specific account. Aurora only. Removes calendar from list of those shared with the specific account. Aurora only. Parameters `$oAccount` Account object `$sCalendarId` Calendar ID Returns boolean
`public boolean`	# `updateCalendarShareToAll( CAccount $oAccount, string $sCalendarId, boolean $bShareToAll, integer $iPermission )` (Aurora only) Share or remove sharing calendar with all users. (Aurora only) Share or remove sharing calendar with all users. Parameters `$oAccount` Account object `$sCalendarId` Calendar ID `$bShareToAll` If set to true, add sharing; if false, sharing is removed `$iPermission` Permissions set for the account. Accepted values: - ECalendarPermission::Read (read-only access); - ECalendarPermission::Write (read/write access); - ECalendarPermission::RemovePermission (effectively removes sharing with the account). Returns boolean
`public boolean`	# `updateCalendarShares( CAccount $oAccount, string $sCalendarId, array $aShares )` (Aurora only) Share or remove sharing calendar with the listed users. (Aurora only) Share or remove sharing calendar with the listed users. Parameters `$oAccount` Account object `$sCalendarId` Calendar ID `$aShares` Array defining list of users and permissions. Each array item needs to have the following keys: ["email"] - email which denotes user the calendar is shared to; ["access"] - permission settings equivalent to those used in updateCalendarShare method. Returns boolean
`public boolean`	# `publicCalendar( CAccount $oAccount, string $sCalendarId, boolean $bIsPublic = false )` Set/unset calendar as public. Set/unset calendar as public. Parameters `$oAccount` Account object `$sCalendarId` Calendar ID `$bIsPublic` If set to true, calendar is made public; if false, setting as public gets cancelled Returns boolean
`public boolean`	# `deleteCalendarShare( CAccount $oAccount, string $sCalendarId, string $sUserId )` (Aurora only) Removes sharing calendar with the specific user account. (Aurora only) Removes sharing calendar with the specific user account. Parameters `$oAccount` Account object `$sCalendarId` Calendar ID `$sUserId` User ID Returns boolean
`public boolean`	# `updateCalendarShare( CAccount $oAccount, string $sCalendarId, string $sUserId, integer $iPermission )` Share or remove sharing calendar with the specific user account. Aurora only. Share or remove sharing calendar with the specific user account. Aurora only. Parameters `$oAccount` Account object `$sCalendarId` Calendar ID `$sUserId` User Id `$iPermission` Permissions set for the account. Accepted values: - ECalendarPermission::Read (read-only access); - ECalendarPermission::Write (read/write access); - ECalendarPermission::RemovePermission (effectively removes sharing with the account). Returns boolean
`public string\|boolean`	# `exportCalendarToIcs( CAccount $oAccount, string $sCalendarId )` Returns calendar data as ICS data. Returns calendar data as ICS data. Parameters `$oAccount` Account object `$sCalendarId` Calendar ID Returns string\|boolean
`public integer\|boolean`	# `importToCalendarFromIcs( CAccount $oAccount, string $sCalendarId, string $sTempFileName )` Populates calendar from .ICS file. Populates calendar from .ICS file. Parameters `$oAccount` Account object `$sCalendarId` Calendar ID `$sTempFileName` .ICS file name data are imported from Returns integer\|boolean integer (number of events added)
`public array\|boolean`	# `getPublicEvents( string $sCalendarId, string $dStart = null, string $dFinish = null, string $sTimezone = 'UTC', integer $iTimezoneOffset = 0 )` Returns list of events of public calendar within date range. Returns list of events of public calendar within date range. Parameters `$sCalendarId` Calendar ID `$dStart` Date range start `$dFinish` Date range end `$sTimezone` Timezone identifier `$iTimezoneOffset` Offset value for timezone Returns array\|boolean
`public array\|boolean`	# `getEvents( CAccount $oAccount, array $mCalendarId, string $dStart = null, string $dFinish = null )` Account object Account object Parameters `$oAccount` Account object `$mCalendarId` string $mCalendarId Calendar ID `$dStart` Date range start `$dFinish` Date range end Returns array\|boolean
`public array\|boolean`	# `getEvent( CAccount $oAccount, string $sCalendarId, string $sEventId )` Return specific event. Return specific event. Parameters `$oAccount` Account object `$sCalendarId` Calendar ID `$sEventId` Event ID Returns array\|boolean
`public array\|boolean`	# `getBaseEvent( CAccount $oAccount, string $sCalendarId, string $sEventId )` For recurring event, gets a base one. For recurring event, gets a base one. Parameters `$oAccount` Account object `$sCalendarId` Calendar ID `$sEventId` Event ID Returns array\|boolean
`public array\|boolean`	# `getExpandedEvent( CAccount $oAccount, string $sCalendarId, string $sEventId, string $dStart = null, string $dEnd = null )` For recurring event, gets all occurences within a date range. For recurring event, gets all occurences within a date range. Parameters `$oAccount` Account object `$sCalendarId` Calendar ID `$sEventId` Event ID `$dStart` Date range start `$dEnd` Date range end Returns array\|boolean
`public mixed`	# `createEventFromRaw( CAccount $oAccount, string $sCalendarId, string $sEventId, array $sData )` Parameters `$oAccount` `$sCalendarId` `$sEventId` `$sData` Returns mixed
`public mixed`	# `createEvent( CAccount $oAccount, CEvent $oEvent )` Creates event from event object. Creates event from event object. Parameters `$oAccount` Account object `$oEvent` Event object Returns mixed
`public`	# `updateEventGroups( CAccount $oAccount, CEvent $oEvent )` Parameters `$oAccount` `$oEvent`
`public boolean`	# `updateEvent( CAccount $oAccount, CEvent $oEvent )` Update events using event object. Update events using event object. Parameters `$oAccount` Account object `$oEvent` Event object Returns boolean
`public boolean`	# `moveEvent( CAccount $oAccount, string $sCalendarId, string $sCalendarIdNew, string $sEventId )` Moves event to a different calendar. Moves event to a different calendar. Parameters `$oAccount` Account object `$sCalendarId` Current calendar ID `$sCalendarIdNew` New calendar ID `$sEventId` Event ID Returns boolean
`public`	# `updateEventGroupByMoving( string $sCalendarId, string $sEventId, string $sNewCalendarId )` Parameters `$sCalendarId` `$sEventId` `$sNewCalendarId`
`public boolean`	# `updateExclusion( CAccount $oAccount, CEvent $oEvent, string $sRecurrenceId, boolean $bDelete = false )` Updates or deletes exclusion from recurring event. Updates or deletes exclusion from recurring event. Parameters `$oAccount` Account object `$oEvent` Event object `$sRecurrenceId` Recurrence ID `$bDelete` If true, exclusion is deleted Returns boolean
`public boolean`	# `deleteExclusion( CAccount $oAccount, string $sCalendarId, string $sEventId, string $iRecurrenceId )` deleteExclusion deleteExclusion Parameters `$oAccount` Account object `$sCalendarId` Calendar ID `$sEventId` Event ID `$iRecurrenceId` Recurrence ID Returns boolean
`public array\|boolean`	# `getReminders( integer $start = null, integer $end = null )` Parameters `$start` `$end` Returns array\|boolean
`public boolean`	# `deleteReminder( string $sEventId )` Parameters `$sEventId` Returns boolean
`public boolean`	# `deleteReminderByCalendar( string $sCalendarUri )` Parameters `$sCalendarUri` Returns boolean
`public boolean`	# `updateReminder( string $sEmail, string $sCalendarUri, string $sEventId, string $sData )` Parameters `$sEmail` `$sCalendarUri` `$sEventId` `$sData` Returns boolean
`public boolean`	# `updateAppointment( CAccount $oAccount, string $sCalendarId, string $sEventId, string $sAttendee, string $sAction )` Processing response to event invitation. Aurora only. Processing response to event invitation. Aurora only. Parameters `$oAccount` Account object `$sCalendarId` Calendar ID `$sEventId` Event ID `$sAttendee` Attendee identified by email address `$sAction` Appointment actions. Accepted values: - "ACCEPTED" - "DECLINED" - "TENTATIVE" Returns boolean
`public boolean`	# `appointmentAction( CAccount\|string $oAccount, string $sAttendee, string $sAction, string $sCalendarId, string $sData, boolean $bExternal = false )` Allows for responding to event invitation (accept / decline / tentative). Aurora only. Allows for responding to event invitation (accept / decline / tentative). Aurora only. Parameters `$oAccount` $mAccount Account object `$sAttendee` Attendee identified by email address `$sAction` Appointment actions. Accepted values: - "ACCEPTED" - "DECLINED" - "TENTATIVE" `$sCalendarId` Calendar ID `$sData` ICS data of the response `$bExternal` If true, it is assumed attendee is external to the system Returns boolean
`public CCalendar\|false`	# `getDefaultCalendar( CAccount $oAccount )` Returns default calendar of the account. Returns default calendar of the account. Parameters `$oAccount` Account object Returns `CCalendar`\|false $oCalendar
`public boolean`	# `getCalendars( CAccount $oAccount )` Parameters `$oAccount` Returns boolean
`public boolean`	# `deleteEvent( CAccount $oAccount, string $sCalendarId, string $sEventId )` Deletes event. Deletes event. Parameters `$oAccount` Account object `$sCalendarId` Calendar ID `$sEventId` Event ID Returns boolean
`public array\|boolean`	# `processICS( CAccount $oAccount, string $sData, string $mFromEmail, boolean $bUpdateAttendeeStatus = false )` Parameters `$oAccount` `$sData` `$mFromEmail` `$bUpdateAttendeeStatus` Returns array\|boolean
`public CAccount\|false`	# `getAccountFromAccountList( CAccount $oAccount, string $sEmail )` Parameters `$oAccount` `$sEmail` Returns `CAccount`\|false $oAccount
`public boolean`	# `clearAllCalendars( CAccount $oAccount )` Parameters `$oAccount` Returns boolean

Properties summary

`protected`	`$ApiUsersManager`	#
`protected`	`$oApiCapabilityManager`	#

Packages

Classes

Class CApiCalendarManager

Methods summary

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters