Bitrix API

Sharing

Table of Contents

Constants

ERROR_CODE_100010  = 100010
ERROR_CODE_100020  = 100020
FEATURE_NAME  = 'calendar_sharing'

Methods

__construct()  : mixed
deactivateUserLink()  : Result
disable()  : Result
disabling sharing for user by creating public link for sharing calendar
enable()  : Result
enabling sharing for user by creating public link for calendar
generateUserJointLink()  : Result
getActiveLinkShortUrl()  : string|null
gets a short url for user's active public link for sharing calendar
getActiveLinkUrl()  : string|null
gets an url for user's active public link for sharing calendar
getAllUserLinkInfo()  : array<string|int, mixed>
getLinkInfo()  : array<string|int, mixed>
getLinkSettings()  : array<string|int, mixed>
getOptions()  : array<string|int, mixed>
getUserInfo()  : array<string|int, mixed>
getUserLink()  : UserLink|null
gets an active UserLink object
increaseFrequentUse()  : Result
isEnabled()  : bool
checks if user has an active public link for sharing calendar
setSharingSettingsCollapsed()  : void
setSortJointLinksByFrequentUse()  : void

Constants

ERROR_CODE_100010

public mixed ERROR_CODE_100010 = 100010

ERROR_CODE_100020

public mixed ERROR_CODE_100020 = 100020

FEATURE_NAME

public mixed FEATURE_NAME = 'calendar_sharing'

Methods

__construct()

public __construct(int $userId) : mixed
Parameters
$userId : int

deactivateUserLink()

public deactivateUserLink(string|null $hash) : Result
Parameters
$hash : string|null
Tags
throws
ArgumentException
throws
SystemException|Exception
Return values
Result

disable()

disabling sharing for user by creating public link for sharing calendar

public disable() : Result
Tags
throws
ArgumentException
throws
SystemException
Return values
Result

enable()

enabling sharing for user by creating public link for calendar

public enable() : Result
Tags
throws
ArgumentException
throws
SystemException
Return values
Result

generateUserJointLink()

public generateUserJointLink(array<string|int, mixed> $memberIds) : Result
Parameters
$memberIds : array<string|int, mixed>
Tags
throws
ArgumentException
throws
SystemException
Return values
Result

getActiveLinkShortUrl()

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

public getActiveLinkShortUrl() : string|null
Tags
throws
ArgumentException
throws
SystemException
Return values
string|null

getActiveLinkUrl()

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

public getActiveLinkUrl() : string|null
Tags
throws
ArgumentException
throws
SystemException
Return values
string|null

getAllUserLinkInfo()

public getAllUserLinkInfo() : array<string|int, mixed>
Tags
throws
ArgumentException
throws
SystemException
Return values
array<string|int, mixed>

getLinkInfo()

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

getLinkSettings()

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

getOptions()

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

getUserInfo()

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

getUserLink()

gets an active UserLink object

public getUserLink() : UserLink|null
Tags
throws
ArgumentException
throws
SystemException
Return values
UserLink|null

increaseFrequentUse()

public increaseFrequentUse(string|null $hash) : Result
Parameters
$hash : string|null
Tags
throws
Exception
Return values
Result

isEnabled()

checks if user has an active public link for sharing calendar

public isEnabled() : bool
Tags
throws
ArgumentException
throws
SystemException
Return values
bool

setSharingSettingsCollapsed()

public setSharingSettingsCollapsed(bool $isCollapsed) : void
Parameters
$isCollapsed : bool

setSortJointLinksByFrequentUse()

public setSortJointLinksByFrequentUse(bool $sortByFrequentUse) : void
Parameters
$sortByFrequentUse : bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results