Класс Sharing

Открытые члены
	__construct (int $userId)
	enable ()
	disable ()
	deactivateUserLink (?string $hash)
	increaseFrequentUse (?string $hash)
	generateUserJointLink (array $memberIds)
	isEnabled ()
	getLinkInfo ()
	getActiveLinkShortUrl ()
	getActiveLinkUrl ()
	getUserLink ()
	getLinkSettings ()

Открытые атрибуты
const	ERROR_CODE_100010 = 100010
const	ERROR_CODE_100020 = 100020

Защищенные члены
	getUserLinkByUserId (int $userId)
	getAllUserLinks ()
	getUserJointLinks ()
	getUserLinkByHash (?string $hash)

Защищенные данные
int	$userId

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

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

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

__construct()

__construct

(

int

$userId

)

Аргументы

int

$userId

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

Методы

deactivateUserLink()

deactivateUserLink

(

?string

$hash

)

Аргументы

string | null

$hash

Возвращает

Result

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\SystemException|\Exception

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

disable()

disable

(

)

disabling sharing for user by creating public link for sharing calendar

Возвращает

Result

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\SystemException

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

enable()

enable

(

)

enabling sharing for user by creating public link for calendar

Возвращает

Result

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\SystemException

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

generateUserJointLink()

generateUserJointLink

(

array

$memberIds

)

Аргументы

array

$memberIds

Возвращает

Result

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\SystemException

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

getActiveLinkShortUrl()

getActiveLinkShortUrl

(

)

gets a short url for user's active public link for sharing calendar

Возвращает

string|null

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\SystemException

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

getActiveLinkUrl()

getActiveLinkUrl

(

)

gets an url for user's active public link for sharing calendar

Возвращает

string|null

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\SystemException

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

getAllUserLinks()

getAllUserLinks ( )

protected

Возвращает

array

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\SystemException

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

getLinkInfo()

getLinkInfo

(

)

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

getLinkSettings()

getLinkSettings

(

)

Возвращает

array

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

getUserJointLinks()

getUserJointLinks ( )

protected

Возвращает

array

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\SystemException

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

getUserLink()

getUserLink

(

)

gets an active UserLink object

Возвращает

UserLink|null

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\SystemException

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

getUserLinkByHash()

getUserLinkByHash ( ?string $hash )

protected

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

getUserLinkByUserId()

getUserLinkByUserId ( int $userId )

protected

Аргументы

int

$userId

Возвращает

UserLink|null

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\SystemException

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

increaseFrequentUse()

increaseFrequentUse

(

?string

$hash

)

Аргументы

string | null

$hash

Возвращает

Result

Исключения

Exception

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

isEnabled()

isEnabled

(

)

checks if user has an active public link for sharing calendar

Возвращает

bool

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\SystemException

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

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

$userId

int $userId

protected

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

ERROR_CODE_100010

const ERROR_CODE_100010 = 100010

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

ERROR_CODE_100020

const ERROR_CODE_100020 = 100020

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