Bitrix API

Factory

Table of Contents

Methods

createCrmDealJointLink()  : CrmDealLink
createCrmDealLink()  : CrmDealLink
creates crm deal public link for calendar sharing
createEventLink()  : EventLink
creates public link for sharing event
createGroupJointLink()  : EntityInterface
createGroupLink()  : self
createUserJointLink()  : EntityInterface
createUserLink()  : $this
creates user public link for calendar sharing by user id
generateMembersHash()  : string|null
getAllUserLinks()  : array<string|int, mixed>
getCrmDealJointLink()  : EntityInterface|null
getCrmDealLink()  : EntityInterface|null
gets crm deal public link for calendar sharing
getDeletedEventLinkByEventId()  : EntityInterface|null
gets calendar sharing event public link by enetId
getEventLinkByEventId()  : EntityInterface|null
gets calendar sharing event public link by eventId
getGroupJointLinkByMembersHash()  : EntityInterface|null
getGroupLinks()  : array<string|int, mixed>
getInstance()  : Factory
getJointLinkByMembersHash()  : EntityInterface|null
getLastSentCrmDealLink()  : EntityInterface|null
getLinkArrayByHash()  : array<string|int, mixed>|null
returns public link data in array by hash
getLinkByHash()  : EntityInterface|null
gets public link object by hash
getParentLinkByConferenceId()  : JointLink|null
getUserJointLinks()  : array<string|int, mixed>
gets user joint public links by user id
getUserLinks()  : array<string|int, mixed>
gets user public links by user id

Methods

createCrmDealLink()

creates crm deal public link for calendar sharing

public createCrmDealLink(int $ownerId, int $entityId[, array<string|int, mixed>|null $memberIds = [] ][, int|null $contactId = null ][, int|null $contactType = null ][, string|null $channelId = null ][, string|null $senderId = null ]) : CrmDealLink
Parameters
$ownerId : int
$entityId : int
$memberIds : array<string|int, mixed>|null = []
$contactId : int|null = null
$contactType : int|null = null
$channelId : string|null = null
$senderId : string|null = null
Tags
throws
ArgumentException
Return values
CrmDealLink

createEventLink()

creates public link for sharing event

public createEventLink(array<string|int, mixed> $params) : EventLink
Parameters
$params : array<string|int, mixed>
Tags
throws
ArgumentException
Return values
EventLink

createGroupJointLink()

public createGroupJointLink(int $groupId, array<string|int, mixed> $memberIds) : EntityInterface
Parameters
$groupId : int
$memberIds : array<string|int, mixed>
Return values
EntityInterface

createGroupLink()

public createGroupLink(int $groupId, int $userId) : self
Parameters
$groupId : int
$userId : int
Return values
self

createUserJointLink()

public createUserJointLink(int $userId, array<string|int, mixed> $memberIds) : EntityInterface
Parameters
$userId : int
$memberIds : array<string|int, mixed>
Return values
EntityInterface

createUserLink()

creates user public link for calendar sharing by user id

public createUserLink(int $userId) : $this
Parameters
$userId : int
Tags
throws
ArgumentException
Return values
$this

generateMembersHash()

public generateMembersHash(int $userId, array<string|int, mixed> $memberIds[, string $prefix = '' ]) : string|null
Parameters
$userId : int
$memberIds : array<string|int, mixed>
$prefix : string = ''
Return values
string|null

getAllUserLinks()

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

getCrmDealJointLink()

public getCrmDealJointLink(int $entityId, int $ownerId[, int|null $contactId = null ][, int|null $contactType = null ]) : EntityInterface|null
Parameters
$entityId : int
$ownerId : int
$contactId : int|null = null
$contactType : int|null = null
Return values
EntityInterface|null

getCrmDealLink()

gets crm deal public link for calendar sharing

public getCrmDealLink(int $entityId, int $ownerId[, array<string|int, mixed>|null $memberIds = [] ][, int|null $contactId = null ][, int|null $contactType = null ]) : EntityInterface|null
Parameters
$entityId : int
$ownerId : int
$memberIds : array<string|int, mixed>|null = []
$contactId : int|null = null
$contactType : int|null = null
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
EntityInterface|null

getDeletedEventLinkByEventId()

gets calendar sharing event public link by enetId

public getDeletedEventLinkByEventId(int $eventId) : EntityInterface|null
Parameters
$eventId : int
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
EntityInterface|null

getEventLinkByEventId()

gets calendar sharing event public link by eventId

public getEventLinkByEventId(int $eventId[, bool $searchActiveOnly = true ]) : EntityInterface|null
Parameters
$eventId : int
$searchActiveOnly : bool = true
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
EntityInterface|null

getGroupJointLinkByMembersHash()

public getGroupJointLinkByMembersHash(int $groupId, string $membersHash) : EntityInterface|null
Parameters
$groupId : int
$membersHash : string
Return values
EntityInterface|null

getGroupLinks()

public getGroupLinks(int $groupId, int $userId) : array<string|int, mixed>
Parameters
$groupId : int
$userId : int
Return values
array<string|int, mixed>

getLinkArrayByHash()

returns public link data in array by hash

public getLinkArrayByHash(string $hash) : array<string|int, mixed>|null
Parameters
$hash : string
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>|null

getLinkByHash()

gets public link object by hash

public getLinkByHash(string $hash) : EntityInterface|null
Parameters
$hash : string
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
EntityInterface|null

getParentLinkByConferenceId()

public getParentLinkByConferenceId(string $conferenceId) : JointLink|null
Parameters
$conferenceId : string
Return values
JointLink|null

getUserJointLinks()

gets user joint public links by user id

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

getUserLinks()

gets user public links by user id

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results