Bitrix API

MemberService

Table of Contents

Methods

__construct()  : mixed
addForDocument()  : Result
cleanByDocumentId()  : Result
cleanByDocumentUid()  : Result
convertDepartmentIdToNodeId()  : int|null
countReadySigners()  : int
countSuccessfulSigners()  : int
countUnfinishedSigners()  : int
countWaitingSigners()  : int
getAssignee()  : Member|null
getById()  : Member|null
getByUid()  : Member|null
getCommunications()  : array<string|int, mixed>
getCountForCurrentUserAction()  : int
getCurrentParticipantFromCompanySide()  : Member|null
getLinkForSignedFile()  : Result
getLinkForSigning()  : Result
getMemberOfDocument()  : Member|null
getMemberRepresentedName()  : string|null
getSigner()  : Member|null
getStampFileFromMemberOrEntity()  : File|null
getUniqueSignersCount()  : Result
getUserIdForMember()  : int|null
getUserIdsByDocument()  : array<int, int>
getUserIdsForMembers()  : array<int, int>
getUserRepresentedName()  : string
isDocumentHasSuccessfulSigners()  : bool
isUserLinksWithMember()  : bool
listByDocumentId()  : MemberCollection
modifyCommunicationChannel()  : Result
prepareDepartmentsForSync()  : Result
remove()  : Result
removeFromDocumentAndPart()  : Result
saveStampFile()  : Result
setProfileProviderCache()  : static
setupB2eMembers()  : Result
skipChatInvitationForMember()  : bool
Skip invitation if initiator signs immediately after document creation.

Methods

__construct()

public __construct([MemberRepository|null $memberRepository = null ][, DocumentRepository|null $documentRepository = null ][, MemberNodeRepository|null $memberNodeRepository = null ][, FileRepository|null $fileRepository = null ][, B2eDocumentService|null $b2eDocumentService = null ]) : mixed
Parameters
$memberRepository : MemberRepository|null = null
$documentRepository : DocumentRepository|null = null
$memberNodeRepository : MemberNodeRepository|null = null
$fileRepository : FileRepository|null = null
$b2eDocumentService : B2eDocumentService|null = null

addForDocument()

public addForDocument(string $documentUid, string $entityType, int $entityId, int $party[, int $presetId = 0 ][, int|null $representativeId = null ][, string|null $role = null ][, ReminderType $reminderType = TypeMemberNotificationReminderType::NONE ][, int|null $employeeId = null ]) : Result
Parameters
$documentUid : string
$entityType : string
$entityId : int
$party : int
$presetId : int = 0
$representativeId : int|null = null
$role : string|null = null
$reminderType : ReminderType = TypeMemberNotificationReminderType::NONE
$employeeId : int|null = null
Return values
Result

cleanByDocumentId()

public cleanByDocumentId(int $documentId) : Result
Parameters
$documentId : int
Return values
Result

cleanByDocumentUid()

public cleanByDocumentUid(string $documentUid) : Result
Parameters
$documentUid : string
Return values
Result

convertDepartmentIdToNodeId()

public convertDepartmentIdToNodeId(int $departmentId) : int|null
Parameters
$departmentId : int
Return values
int|null

countReadySigners()

public countReadySigners(int $documentId) : int
Parameters
$documentId : int
Return values
int

countSuccessfulSigners()

public countSuccessfulSigners(int $documentId) : int
Parameters
$documentId : int
Return values
int

countUnfinishedSigners()

public countUnfinishedSigners(int $documentId) : int
Parameters
$documentId : int
Return values
int

countWaitingSigners()

public countWaitingSigners(int $documentId) : int
Parameters
$documentId : int
Return values
int

getCommunications()

public getCommunications(Member $member) : array<string|int, mixed>
Parameters
$member : Member
Return values
array<string|int, mixed>

getCountForCurrentUserAction()

public getCountForCurrentUserAction(int $userId) : int
Parameters
$userId : int
Return values
int

getLinkForSignedFile()

public getLinkForSignedFile(Member $member) : Result
Parameters
$member : Member
Return values
Result

getLinkForSigning()

public getLinkForSigning(Member $member) : Result
Parameters
$member : Member
Return values
Result

getMemberRepresentedName()

public getMemberRepresentedName(Member $member) : string|null
Parameters
$member : Member
Return values
string|null

getUserIdsByDocument()

public getUserIdsByDocument(Document $document) : array<int, int>
Parameters
$document : Document
Return values
array<int, int>

getUserRepresentedName()

public getUserRepresentedName(int $userId) : string
Parameters
$userId : int
Return values
string

isDocumentHasSuccessfulSigners()

public isDocumentHasSuccessfulSigners(int $documentId) : bool
Parameters
$documentId : int
Return values
bool

modifyCommunicationChannel()

public modifyCommunicationChannel(string $uid, string $channelType, string $channelValue) : Result
Parameters
$uid : string
$channelType : string
$channelValue : string
Return values
Result

remove()

public remove(string $uid) : Result
Parameters
$uid : string
Return values
Result

removeFromDocumentAndPart()

public removeFromDocumentAndPart(string $documentUid, string $entityType, string $entityId, int $party) : Result
Parameters
$documentUid : string
$entityType : string
$entityId : string
$party : int
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
Result

saveStampFile()

public saveStampFile(int $fileId, Member $member) : Result
Parameters
$fileId : int
$member : Member
Return values
Result

setProfileProviderCache()

public setProfileProviderCache(UserCache|null $userCache) : static
Parameters
$userCache : UserCache|null
Return values
static

setupB2eMembers()

public setupB2eMembers(string $documentUid, MemberCollection $memberCollection, int $representativeId) : Result
Parameters
$documentUid : string
$memberCollection : MemberCollection
$representativeId : int
Return values
Result

skipChatInvitationForMember()

Skip invitation if initiator signs immediately after document creation.

public skipChatInvitationForMember(Member $member, Document $document) : bool
Parameters
$member : Member
$document : Document
Tags
todo

if part > 1, check userId for reviewer/editor parties

Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results