Bitrix API

GoogleApiSync

FinalYes

Class GoogleApiSync

Table of Contents

Constants

CHANNEL_EXPIRATION  = 604800
CONNECTION_CHANNEL_TYPE  = 'BX_CONNECTION'
DATE_TIME_FORMAT  = 'Y-m-d\TH:i:sP'
DEFAULT_TIMEZONE  = 'UTC'
END_OF_DATE  = "01.01.2038"
EXTERNAL_LINK  = 'https://www.bitrix24.com/controller/google_calendar_push.php?target_host='
MAXIMUM_CONNECTIONS_TO_SYNC  = 3
ONE_DAY  = 86400
SECTION_CHANNEL_TYPE  = 'BX_SECTION'
SECTION_CONNECTION_CHANNEL_TYPE  = 'SECTION_CONNECTION'
SYNC_EVENTS_DATE_INTERVAL  = '-1 months'
SYNC_EVENTS_LIMIT  = 50

Methods

__construct()  : mixed
GoogleApiSync constructor.
createCalendar()  : array<string|int, mixed>|null
deleteCalendar()  : void
deleteEvent()  : array<string|int, mixed>|mixed
Delete event from specified google calendar
getCalendarItems()  : array<string|int, mixed>
get calendar list from google
getChannelOwner()  : int|null
getEvents()  : array<string|int, mixed>
get google calendar events list.
getNextPageToken()  : string
getNextSyncToken()  : string
getPrimaryId()  : string
get id of Primary (main) calendar
getTransportConnectionError()  : array<string|int, mixed>
Returns connection error code in message;
getTransportErrors()  : array<string|int, mixed>
Check if errors from transport exists
hasMoreEvents()  : mixed
saveBatchEvents()  : array<string|int, mixed>
saveEvent()  : array<string|int, mixed>|null
startWatchCalendarList()  : array<string|int, mixed>
Creates watch channel for connection
startWatchEventsChannel()  : array<string|int, mixed>|bool
Creates watch channel for new events
stopChannel()  : mixed
Closes watch channel and asking google to stop pushes
testConnection()  : bool
Test ability to establish google api connection
updateCalendar()  : void
updateCalendarList()  : array<string|int, mixed>
updateLastResultConnection()  : void
updateSuccessLastResultConnection()  : void

Constants

CONNECTION_CHANNEL_TYPE

public mixed CONNECTION_CHANNEL_TYPE = 'BX_CONNECTION'

DATE_TIME_FORMAT

public mixed DATE_TIME_FORMAT = 'Y-m-d\TH:i:sP'

EXTERNAL_LINK

public mixed EXTERNAL_LINK = 'https://www.bitrix24.com/controller/google_calendar_push.php?target_host='

MAXIMUM_CONNECTIONS_TO_SYNC

public mixed MAXIMUM_CONNECTIONS_TO_SYNC = 3

SECTION_CHANNEL_TYPE

public mixed SECTION_CHANNEL_TYPE = 'BX_SECTION'

SECTION_CONNECTION_CHANNEL_TYPE

public mixed SECTION_CONNECTION_CHANNEL_TYPE = 'SECTION_CONNECTION'

SYNC_EVENTS_DATE_INTERVAL

public mixed SYNC_EVENTS_DATE_INTERVAL = '-1 months'

Methods

__construct()

GoogleApiSync constructor.

public __construct([int $userId = 0 ][, int $connectionId = 0 ]) : mixed
Parameters
$userId : int = 0
$connectionId : int = 0

createCalendar()

public createCalendar(mixed $calendar) : array<string|int, mixed>|null
Parameters
$calendar : mixed
Return values
array<string|int, mixed>|null

deleteCalendar()

public deleteCalendar(string $gApiCalendarId) : void
Parameters
$gApiCalendarId : string
Tags
throws
ArgumentException

deleteEvent()

Delete event from specified google calendar

public deleteEvent(mixed $eventId, mixed $calendarId) : array<string|int, mixed>|mixed
Parameters
$eventId : mixed
$calendarId : mixed
Return values
array<string|int, mixed>|mixed

getCalendarItems()

get calendar list from google

public getCalendarItems([string $syncToken = null ]) : array<string|int, mixed>
Parameters
$syncToken : string = null
Tags
throws
ArgumentException
Return values
array<string|int, mixed>

getChannelOwner()

public static getChannelOwner([string|null $channelId = null ]) : int|null
Parameters
$channelId : string|null = null
Return values
int|null

getEvents()

get google calendar events list.

public getEvents(array<string|int, mixed> $calendarData) : array<string|int, mixed>

By default selecting primary calendar

Parameters
$calendarData : array<string|int, mixed>
Return values
array<string|int, mixed>

getNextPageToken()

public getNextPageToken() : string
Return values
string

getNextSyncToken()

public getNextSyncToken() : string
Return values
string

getPrimaryId()

get id of Primary (main) calendar

public getPrimaryId() : string
Return values
string

getTransportConnectionError()

Returns connection error code in message;

public getTransportConnectionError() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTransportErrors()

Check if errors from transport exists

public getTransportErrors() : array<string|int, mixed>
Return values
array<string|int, mixed>

saveBatchEvents()

public saveBatchEvents(array<string|int, mixed> $events, string $gApiCalendarId, array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$events : array<string|int, mixed>
$gApiCalendarId : string
$params : array<string|int, mixed>
Tags
throws
ArgumentException
Return values
array<string|int, mixed>

saveEvent()

public saveEvent(mixed $eventData, mixed $calendarId[, array<string|int, mixed> $parameters = [] ]) : array<string|int, mixed>|null
Parameters
$eventData : mixed
$calendarId : mixed
$parameters : array<string|int, mixed> = []
Tags
throws
ObjectException
Return values
array<string|int, mixed>|null

startWatchCalendarList()

Creates watch channel for connection

public startWatchCalendarList(mixed $name) : array<string|int, mixed>
Parameters
$name : mixed
Tags
throws
ArgumentException
Return values
array<string|int, mixed>

startWatchEventsChannel()

Creates watch channel for new events

public startWatchEventsChannel([string $calendarId = 'primary' ]) : array<string|int, mixed>|bool
Parameters
$calendarId : string = 'primary'
Return values
array<string|int, mixed>|bool

stopChannel()

Closes watch channel and asking google to stop pushes

public stopChannel(mixed $channelId, mixed $resourceId) : mixed
Parameters
$channelId : mixed
$resourceId : mixed

testConnection()

Test ability to establish google api connection

public testConnection() : bool
Return values
bool

updateCalendar()

public updateCalendar(string $gApiCalendarId, array<string|int, mixed> $calendarData) : void
Parameters
$gApiCalendarId : string
$calendarData : array<string|int, mixed>
Tags
throws
ArgumentException

updateCalendarList()

public updateCalendarList(string $gApiCalendarId, array<string|int, mixed> $section) : array<string|int, mixed>
Parameters
$gApiCalendarId : string
$section : array<string|int, mixed>
Tags
throws
ArgumentException
Return values
array<string|int, mixed>

updateLastResultConnection()

public updateLastResultConnection(string $lastResult) : void
Parameters
$lastResult : string

updateSuccessLastResultConnection()

public updateSuccessLastResultConnection() : void 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results