Класс Sharing

Открытые члены
	__construct (int $userId)
	enable ()
	disable ()
	deactivateUserLink (?string $hash)
	increaseFrequentUse (?string $hash)
	isEnabled ()
	getLinkInfo ()
	getUserInfo ()
	getActiveLinkShortUrl ()
	getActiveLinkUrl ()
	getUserLink ()
	getLinkSettings ()
	getOptions ()
	setSortJointLinksByFrequentUse (bool $sortByFrequentUse)
	setSharingSettingsCollapsed (bool $isCollapsed)

Поля данных
const	FEATURE_NAME = 'calendar_sharing'
const	ERROR_CODE_100010 = 100010
const	ERROR_CODE_100020 = 100020

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

Защищенные данные
int	$userId
UserLink null bool	$userLink = false
const	OPTION_SORT_JOINT_LINKS_BY_FREQUENT_USE = 'sortJointLinksByFrequentUse'
const	OPTION_SHARING_SETTINGS_COLLAPSED = 'sharingSettingsCollapsed'

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

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

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

__construct()

__construct

(

int

$userId

)

Аргументы

int

$userId

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

Методы

deactivateUserLink()

deactivateUserLink

(

?string

$hash

)

Аргументы

string | null

$hash

Возвращает

Result

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\SystemException|\Exception

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

disable()

disable

(

)

disabling sharing for user by creating public link for sharing calendar

Возвращает

Result

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\SystemException

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

enable()

enable

(

)

enabling sharing for user by creating public link for calendar

Возвращает

Result

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\SystemException

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

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 строка 252

getActiveLinkUrl()

getActiveLinkUrl

(

)

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

Возвращает

string|null

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\SystemException

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

getAllUserLinks()

getAllUserLinks ( )

protected

Возвращает

array

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\SystemException

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

getLinkInfo()

getLinkInfo

(

)

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

getLinkSettings()

getLinkSettings

(

)

Возвращает

array

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

getOptions()

getOptions

(

)

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

getUserInfo()

getUserInfo

(

)

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

getUserJointLinks()

getUserJointLinks ( )

protected

Возвращает

array

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\SystemException

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

getUserLink()

getUserLink

(

)

gets an active UserLink object

Возвращает

UserLink|null

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\SystemException

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

getUserLinkByHash()

getUserLinkByHash ( ?string $hash )

protected

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

getUserLinkByUserId()

getUserLinkByUserId ( int $userId )

protected

Аргументы

int

$userId

Возвращает

UserLink|null

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\SystemException

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

increaseFrequentUse()

increaseFrequentUse

(

?string

$hash

)

Аргументы

string | null

$hash

Возвращает

Result

Исключения

Exception

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

isEnabled()

isEnabled

(

)

checks if user has an active public link for sharing calendar

Возвращает

bool

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\SystemException

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

setSharingSettingsCollapsed()

setSharingSettingsCollapsed

(

bool

$isCollapsed

)

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

setSortJointLinksByFrequentUse()

setSortJointLinksByFrequentUse

(

bool

$sortByFrequentUse

)

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

Поля

$userId

int $userId

protected

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

$userLink

UserLink null bool $userLink = false

protected

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

ERROR_CODE_100010

const ERROR_CODE_100010 = 100010

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

ERROR_CODE_100020

const ERROR_CODE_100020 = 100020

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

FEATURE_NAME

const FEATURE_NAME = 'calendar_sharing'

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

OPTION_SHARING_SETTINGS_COLLAPSED

const OPTION_SHARING_SETTINGS_COLLAPSED = 'sharingSettingsCollapsed'

protected

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

OPTION_SORT_JOINT_LINKS_BY_FREQUENT_USE

const OPTION_SORT_JOINT_LINKS_BY_FREQUENT_USE = 'sortJointLinksByFrequentUse'

protected

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

---

Объявления и описания членов класса находятся в файле:

• C:/bitrix/modules/calendar/lib/sharing/sharing.php