Bitrix-D7 22.6
 
Загрузка...
Поиск...
Не найдено
Класс ApiService

Открытые члены

 __construct (array $server=[], int $userId=null)
 
 getPrinciples ($connection, $server)
 
 getCalendarPath ($connection, $server)
 
 getCalendarList ($connection, $server)
 
 createEvent (string $path, Event $event)
 
 updateEvent (string $path, Event $event, ?array $data)
 
 deleteEvent (string $path, Event $event)
 
 saveInstance (string $path, Event $event, ?array $data, Date $excludeDate=null)
 
 saveRecurrence (string $path, SyncEvent $recurrenceEvent)
 
 createSection (string $path, Section $section)
 
 updateSection (string $path, Section $section)
 
 deleteSection (string $path)
 
 getSectionsList ($path)
 
 getEventsList ($path, $syncToken)
 
 getEventsListWithHref ($path, $hrefs)
 
 prepareUrl (string $url)
 
 getError ()
 

Защищенные данные

ApiClient $apiClient = null
 
CDavGroupdavClientCalendar $davClient = null
 
Helper $helper
 
array $error = null
 

Подробное описание

См. определение в файле apiservice.php строка 15

Конструктор(ы)

◆ __construct()

__construct ( array  $server = [],
int  $userId = null 
)
Аргументы
array$server
int | null$userId
Исключения

Bitrix\Main\ArgumentNullException

Аргументы
ContextInterface$context
Исключения
BaseException
LoaderException
RemoteAccountException
AuthException

См. определение в файле apiservice.php строка 32

Методы

◆ createEvent()

createEvent ( string  $path,
Event  $event 
)
Аргументы
string$path
Event$event
Возвращает
array|null
Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\LoaderException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. определение в файле apiservice.php строка 157

◆ createSection()

createSection ( string  $path,
Section  $section 
)
Аргументы
string$path
Section$section
Возвращает
array|null
Исключения

Bitrix\Main\LoaderException

См. определение в файле apiservice.php строка 285

◆ deleteEvent()

deleteEvent ( string  $path,
Event  $event 
)
Аргументы
string$path
Event$event
Возвращает
bool|null
Исключения

Bitrix\Main\LoaderException

См. определение в файле apiservice.php строка 201

◆ deleteSection()

deleteSection ( string  $path)
Аргументы
string$path
Возвращает
bool|null
Исключения

Bitrix\Main\LoaderException

См. определение в файле apiservice.php строка 354

◆ getCalendarList()

getCalendarList (   $connection,
  $server 
)
Аргументы
$connection
$server
Возвращает
array|null

См. определение в файле apiservice.php строка 128

◆ getCalendarPath()

getCalendarPath (   $connection,
  $server 
)
Аргументы
$connection
$server
Возвращает
string|null
Исключения

Bitrix\Main\ArgumentNullException

См. определение в файле apiservice.php строка 92

◆ getError()

getError ( )
Возвращает
array|null

См. определение в файле apiservice.php строка 699

◆ getEventsList()

getEventsList (   $path,
  $syncToken 
)

См. определение в файле apiservice.php строка 378

◆ getEventsListWithHref()

getEventsListWithHref (   $path,
  $hrefs 
)

См. определение в файле apiservice.php строка 383

◆ getPrinciples()

getPrinciples (   $connection,
  $server 
)
Аргументы
$connection
$server
Возвращает
string|null
Исключения

Bitrix\Main\ArgumentNullException

См. определение в файле apiservice.php строка 56

◆ getSectionsList()

getSectionsList (   $path)

См. определение в файле apiservice.php строка 373

◆ prepareUrl()

prepareUrl ( string  $url)

См. определение в файле apiservice.php строка 388

◆ saveInstance()

saveInstance ( string  $path,
Event  $event,
?array  $data,
Date  $excludeDate = null 
)
Аргументы
string$path
Event$event
array | null$data
Date | null$excludeDate
Возвращает
array|null
Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\LoaderException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. определение в файле apiservice.php строка 241

◆ saveRecurrence()

saveRecurrence ( string  $path,
SyncEvent  $recurrenceEvent 
)
Аргументы
string$path
SyncEvent$recurrenceEvent
Возвращает
array|null
Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\LoaderException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. определение в файле apiservice.php строка 265

◆ updateEvent()

updateEvent ( string  $path,
Event  $event,
?array  $data 
)
Аргументы
string$path
Event$event
array | null$data
Возвращает
array|null
Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\LoaderException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. определение в файле apiservice.php строка 176

◆ updateSection()

updateSection ( string  $path,
Section  $section 
)
Аргументы
string$path
Section$section
Возвращает
array|int[]|null
Исключения

Bitrix\Main\LoaderException

См. определение в файле apiservice.php строка 317

Данные класса

◆ $apiClient

ApiClient $apiClient = null
protected

См. определение в файле apiservice.php строка 18

◆ $davClient

CDavGroupdavClientCalendar $davClient = null
protected

См. определение в файле apiservice.php строка 20

◆ $error

array $error = null
protected

См. определение в файле apiservice.php строка 24

◆ $helper

Helper $helper
protected

См. определение в файле apiservice.php строка 22