Bitrix API

Helper

Table of Contents

Methods

addTimelineEntry()  : bool
adds new calendar sharing entry in timeline
cancelMeeting()  : bool
cancels event participation
completeActivityWithStatus()  : bool
completes crm deal calendar sharing activity
generateJointLink()  : Result
getChannelById()  : Channel|null
getConferenceChatId()  : array<string|int, mixed>|null
gets chat id of sharing conference by event id
getContactFromChannel()  : To|null
getInstance()  : Helper
hasContact()  : bool
Returns whether channel has contact or not
isSharingCrmAvaible()  : bool
sendLinkToClient()  : Result
sends crm deal calendar sharing link to client

Methods

addTimelineEntry()

adds new calendar sharing entry in timeline

public addTimelineEntry(string $linkHash, string $eventType) : bool
Parameters
$linkHash : string
$eventType : string
Tags
throws
ArgumentException
throws
LoaderException
throws
ObjectPropertyException
throws
SystemException
Return values
bool

cancelMeeting()

cancels event participation

public cancelMeeting(int $eventId) : bool
Parameters
$eventId : int
Tags
throws
LoaderException
Return values
bool

completeActivityWithStatus()

completes crm deal calendar sharing activity

public completeActivityWithStatus(int $activityId, int $ownerTypeId, int $ownerId, string $status) : bool
Parameters
$activityId : int
$ownerTypeId : int
$ownerId : int
$status : string
Return values
bool

generateJointLink()

public generateJointLink(int $entityId, int $ownerId, array<string|int, mixed> $memberIds) : Result
Parameters
$entityId : int
$ownerId : int
$memberIds : array<string|int, mixed>
Return values
Result

getChannelById()

public getChannelById(ItemIdentifier $entity, string $channelId) : Channel|null
Parameters
$entity : ItemIdentifier
$channelId : string
Return values
Channel|null

getConferenceChatId()

gets chat id of sharing conference by event id

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

getContactFromChannel()

public getContactFromChannel(Channel|null $channel, int $contactId, int $contactTypeId) : To|null
Parameters
$channel : Channel|null
$contactId : int
$contactTypeId : int
Return values
To|null

hasContact()

Returns whether channel has contact or not

public hasContact(ItemIdentifier $entity, string $channelId, int $contactId, int $contactTypeId) : bool
Parameters
$entity : ItemIdentifier
$channelId : string
$contactId : int
$contactTypeId : int
Return values
bool

isSharingCrmAvaible()

public static isSharingCrmAvaible() : bool
Return values
bool

sendLinkToClient()

sends crm deal calendar sharing link to client

public sendLinkToClient(int $entityId, int $contactId, int $contactTypeId, string $channelId, string $senderId, array<string|int, mixed> $ruleArray, array<string|int, mixed> $memberIds) : Result
Parameters
$entityId : int
$contactId : int
$contactTypeId : int
$channelId : string
$senderId : string
$ruleArray : array<string|int, mixed>
$memberIds : array<string|int, mixed>
Tags
throws
LoaderException
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
Result 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results