Bitrix API

ApiService

Table of Contents

Methods

__construct()  : mixed
createEvent()  : array<string|int, mixed>|null
createSection()  : array<string|int, mixed>|null
deleteEvent()  : bool|null
deleteSection()  : bool|null
getCalendarList()  : array<string|int, mixed>|null
getCalendarPath()  : string|null
getError()  : array<string|int, mixed>|null
getEventsList()  : array<string|int, mixed>|null
getEventsListWithHref()  : array<string|int, mixed>|null
getPrinciples()  : string|null
getSectionsList()  : mixed
prepareUrl()  : array<string|int, mixed>
saveInstance()  : array<string|int, mixed>|null
saveRecurrence()  : array<string|int, mixed>|null
updateEvent()  : array<string|int, mixed>|null
updateSection()  : array<string|int, mixed>|array<string|int, int>|null

Methods

__construct()

public __construct([array<string|int, mixed> $server = [] ][, int|null $userId = null ]) : mixed
Parameters
$server : array<string|int, mixed> = []
$userId : int|null = null
Tags
throws
ArgumentNullException

createEvent()

public createEvent(string $path, Event $event) : array<string|int, mixed>|null
Parameters
$path : string
$event : Event
Tags
throws
ArgumentException
throws
LoaderException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>|null

createSection()

public createSection(string $path, Section $section) : array<string|int, mixed>|null
Parameters
$path : string
$section : Section
Tags
throws
LoaderException
Return values
array<string|int, mixed>|null

deleteEvent()

public deleteEvent(string $path, Event $event) : bool|null
Parameters
$path : string
$event : Event
Tags
throws
LoaderException
Return values
bool|null

deleteSection()

public deleteSection(string $path) : bool|null
Parameters
$path : string
Tags
throws
LoaderException
Return values
bool|null

getCalendarList()

public getCalendarList(mixed $connection, mixed $server) : array<string|int, mixed>|null
Parameters
$connection : mixed
$server : mixed
Return values
array<string|int, mixed>|null

getCalendarPath()

public getCalendarPath(mixed $connection, mixed $server) : string|null
Parameters
$connection : mixed
$server : mixed
Tags
throws
ArgumentNullException
Return values
string|null

getError()

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

getEventsList()

public getEventsList(mixed $path, mixed $syncToken) : array<string|int, mixed>|null
Parameters
$path : mixed
$syncToken : mixed
Return values
array<string|int, mixed>|null

getEventsListWithHref()

public getEventsListWithHref(mixed $path, mixed $hrefs) : array<string|int, mixed>|null
Parameters
$path : mixed
$hrefs : mixed
Return values
array<string|int, mixed>|null

getPrinciples()

public getPrinciples(mixed $connection, mixed $server) : string|null
Parameters
$connection : mixed
$server : mixed
Tags
throws
ArgumentNullException
Return values
string|null

getSectionsList()

public getSectionsList(mixed $path) : mixed
Parameters
$path : mixed

prepareUrl()

public prepareUrl(string $url) : array<string|int, mixed>
Parameters
$url : string
Return values
array<string|int, mixed>

saveInstance()

public saveInstance(string $path, Event $event, array<string|int, mixed>|null $data[, Date|null $excludeDate = null ]) : array<string|int, mixed>|null
Parameters
$path : string
$event : Event
$data : array<string|int, mixed>|null
$excludeDate : Date|null = null
Tags
throws
ArgumentException
throws
LoaderException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>|null

saveRecurrence()

public saveRecurrence(string $path, SyncEvent $recurrenceEvent) : array<string|int, mixed>|null
Parameters
$path : string
$recurrenceEvent : SyncEvent
Tags
throws
ArgumentException
throws
LoaderException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>|null

updateEvent()

public updateEvent(string $path, Event $event, array<string|int, mixed>|null $data) : array<string|int, mixed>|null
Parameters
$path : string
$event : Event
$data : array<string|int, mixed>|null
Tags
throws
ArgumentException
throws
LoaderException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>|null

updateSection()

public updateSection(string $path, Section $section) : array<string|int, mixed>|array<string|int, int>|null
Parameters
$path : string
$section : Section
Tags
throws
LoaderException
Return values
array<string|int, mixed>|array<string|int, int>|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results