Bitrix API

MemberRepository

Table of Contents

Constants

SIGN_DOCUMENT_LIST_QUERY_REF_FIELD_NAME_COMPANY  = 'REF_COMPANY'

Methods

add()  : Result
addMany()  : Result
convertRoleToInt()  : int
countByDocumentId()  : int
countByDocumentIdAndParty()  : int
countMembersByDocumentIdAndRoleAndStatus()  : int
countNotConfiguredByDocumentId()  : int
deleteAllByDocumentId()  : Result
deleteById()  : mixed
existsByDocumentIdWithReminderTypeNotEqual()  : bool
existsByDocumentIdWithRoleAndStatus()  : bool
getAssigneeByDocumentId()  : Member|null
getByDocumentAndEntityType()  : Member|null
getByDocumentAndPartAndEntityTypeAndEntityId()  : Member|null
getByDocumentIdWithParty()  : Member
getByDocumentIdWithRole()  : Member|null
getById()  : Member|null
getByPartyAndDocumentId()  : Member|null
getByUid()  : Member|null
getCountForCurrentUserAction()  : int
getHavingOldestReminderByDocumentId()  : Member|null
getMembersCountersByDocument()  : array{REFUSED_MEMBERS_COUNTER: int, SUCCESS_MEMBERS_COUNTER: int, READY_MEMBERS_COUNTER: int}
getQueryForMemberCollectionNotWaitStatus()  : Query
getSecondSideMembersForMyDocumentsGrid()  : MemberCollection
getTotalMemberCollectionCountWithNotWaitStatus()  : int
getUserCache()  : UserCache|null
isAnyMyDocumentsGridInProgressStatus()  : bool
isAnyMyDocumentsGridInSignedStatus()  : bool
isDocumentHasEditor()  : bool
isDocumentHasMemberWithRoles()  : bool
isDocumentHasReviewer()  : bool
isSignerExistsByDocumentIdInStatus()  : bool
isSignerExistsByDocumentIdNotInStatus()  : bool
listB2eMemberByDocumentId()  : MemberCollection
listB2eMembersForMyDocumentsGrid()  : MemberCollection
listB2eMembersWithReadyStatus()  : MemberCollection
listB2eMembersWithReadyStatusByDocumentIds()  : MemberCollection
listB2eMembersWithResultFilesForMySafe()  : MemberCollection
listB2eReviewDocumentsByUserId()  : MemberDocumentCollection
listB2eSignedDocumentsByUserId()  : MemberDocumentCollection
listB2eSigningByDocumentIdAndStatuses()  : MemberCollection
listB2eSigningDocumentsByUserId()  : MemberDocumentCollection
listB2eStoppedByDocumentId()  : MemberCollection
listByDocumentId()  : MemberCollection
listByDocumentIdAndMemberStatusesAndCustomFilter()  : MemberCollection
listByDocumentIdAndRoleAndStatus()  : MemberCollection
listByDocumentIdExcludeParty()  : MemberCollection
listByDocumentIdExcludeRole()  : MemberCollection
listByDocumentIdExcludeRoles()  : MemberCollection
listByDocumentIdListAndRoles()  : MemberCollection
listByDocumentIdWithParty()  : MemberCollection
listByDocumentIdWithRole()  : MemberCollection
listByDocumentIdWithRoles()  : MemberCollection
listByDocumentIdWithRolesAndStatuses()  : MemberCollection
listByDocumentIdWithStatuses()  : MemberCollection
listByIds()  : MemberCollection
listByUids()  : MemberCollection
listMembersByDocumentIdAndUserIds()  : MemberCollection
listNotConfiguredByDocumentId()  : MemberCollection
listSignersByUserIdIsDone()  : MemberCollection
listSignersByUserIdIsNotWait()  : MemberCollection
listUserIdsByDocumentId()  : array<int, int>
listUserIdsWithEmployeeIdIsNotSetByDocumentId()  : array<string|int, int>
listWithFilter()  : MemberCollection
markAsConfigured()  : Result
setAsVerified()  : UpdateResult
setUserCache()  : static
update()  : UpdateResult
updateMembersReminderTypeByRole()  : Result
updateQueryByRefFields()  : void

Constants

SIGN_DOCUMENT_LIST_QUERY_REF_FIELD_NAME_COMPANY

public mixed SIGN_DOCUMENT_LIST_QUERY_REF_FIELD_NAME_COMPANY = 'REF_COMPANY'

Methods

convertRoleToInt()

public convertRoleToInt(string $role) : int
Parameters
$role : string
Return values
int

countByDocumentId()

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

countByDocumentIdAndParty()

public countByDocumentIdAndParty(int $documentId, int $party) : int
Parameters
$documentId : int
$party : int
Return values
int

countMembersByDocumentIdAndRoleAndStatus()

public countMembersByDocumentIdAndRoleAndStatus(int $documentId[, array<string|int, mixed> $statuses = [] ][, string $role = Role::SIGNER ]) : int
Parameters
$documentId : int
$statuses : array<string|int, mixed> = []
$role : string = Role::SIGNER
Return values
int

countNotConfiguredByDocumentId()

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

deleteAllByDocumentId()

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

existsByDocumentIdWithReminderTypeNotEqual()

public existsByDocumentIdWithReminderTypeNotEqual(int $documentId, ReminderType $reminderType) : bool
Parameters
$documentId : int
$reminderType : ReminderType
Return values
bool

existsByDocumentIdWithRoleAndStatus()

public existsByDocumentIdWithRoleAndStatus(int $documentId, string $role, string $status) : bool
Parameters
$documentId : int
$role : string
$status : string
Return values
bool

getAssigneeByDocumentId()

public getAssigneeByDocumentId(int $documentId) : Member|null
Parameters
$documentId : int
Return values
Member|null

getByDocumentAndEntityType()

public getByDocumentAndEntityType(int $id, string $entityType) : Member|null
Parameters
$id : int
$entityType : string
Return values
Member|null

getByDocumentAndPartAndEntityTypeAndEntityId()

public getByDocumentAndPartAndEntityTypeAndEntityId(int $documentId, int $party, string $entityType, int|string $entityId) : Member|null
Parameters
$documentId : int
$party : int
$entityType : string
$entityId : int|string
Return values
Member|null

getByDocumentIdWithParty()

public getByDocumentIdWithParty(int $documentId, int $party, string $entityType, int $entityId) : Member
Parameters
$documentId : int
$party : int
$entityType : string
$entityId : int
Return values
Member

getByDocumentIdWithRole()

public getByDocumentIdWithRole(int $documentId, string $role) : Member|null
Parameters
$documentId : int
$role : string
Return values
Member|null

getByPartyAndDocumentId()

public getByPartyAndDocumentId(int $documentId, int $part) : Member|null
Parameters
$documentId : int
$part : int
Return values
Member|null

getCountForCurrentUserAction()

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

getHavingOldestReminderByDocumentId()

public getHavingOldestReminderByDocumentId(int $documentId) : Member|null
Parameters
$documentId : int
Return values
Member|null

getMembersCountersByDocument()

public getMembersCountersByDocument(Document $document, ConditionTree|null $filter) : array{REFUSED_MEMBERS_COUNTER: int, SUCCESS_MEMBERS_COUNTER: int, READY_MEMBERS_COUNTER: int}
Parameters
$document : Document
$filter : ConditionTree|null
Return values
array{REFUSED_MEMBERS_COUNTER: int, SUCCESS_MEMBERS_COUNTER: int, READY_MEMBERS_COUNTER: int}

getSecondSideMembersForMyDocumentsGrid()

public getSecondSideMembersForMyDocumentsGrid(array<string|int, mixed> $documentIds, array<string|int, mixed> $memberIds) : MemberCollection
Parameters
$documentIds : array<string|int, mixed>
$memberIds : array<string|int, mixed>
Return values
MemberCollection

getTotalMemberCollectionCountWithNotWaitStatus()

public getTotalMemberCollectionCountWithNotWaitStatus(int $entityId[, MyDocumentsFilter|null $filter = null ]) : int
Parameters
$entityId : int
$filter : MyDocumentsFilter|null = null
Return values
int

isAnyMyDocumentsGridInProgressStatus()

public isAnyMyDocumentsGridInProgressStatus(int $userId) : bool
Parameters
$userId : int
Return values
bool

isAnyMyDocumentsGridInSignedStatus()

public isAnyMyDocumentsGridInSignedStatus(int $userId) : bool
Parameters
$userId : int
Return values
bool

isDocumentHasEditor()

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

isDocumentHasMemberWithRoles()

public isDocumentHasMemberWithRoles(int $documentId, array<string|int, mixed> $roles) : bool
Parameters
$documentId : int
$roles : array<string|int, mixed>
Return values
bool

isDocumentHasReviewer()

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

isSignerExistsByDocumentIdInStatus()

public isSignerExistsByDocumentIdInStatus(int $documentId, array<string|int, mixed> $statuses) : bool
Parameters
$documentId : int
$statuses : array<string|int, mixed>
Return values
bool

isSignerExistsByDocumentIdNotInStatus()

public isSignerExistsByDocumentIdNotInStatus(int $documentId, array<string|int, mixed> $statuses) : bool
Parameters
$documentId : int
$statuses : array<string|int, mixed>
Return values
bool

listB2eMemberByDocumentId()

public listB2eMemberByDocumentId(int $documentId, ConditionTree|null $filter[, array<string|int, mixed> $roleRelevance = [] ][, array<string|int, mixed> $statusRelevance = [] ][, int $limit = 10 ][, int $offset = 0 ]) : MemberCollection
Parameters
$documentId : int
$filter : ConditionTree|null
$roleRelevance : array<string|int, mixed> = []
$statusRelevance : array<string|int, mixed> = []
$limit : int = 10
$offset : int = 0
Return values
MemberCollection

listB2eMembersWithReadyStatusByDocumentIds()

public listB2eMembersWithReadyStatusByDocumentIds(array<string|int, mixed> $documentIds, int $entityId) : MemberCollection
Parameters
$documentIds : array<string|int, mixed>
$entityId : int
Return values
MemberCollection

listB2eSigningByDocumentIdAndStatuses()

public listB2eSigningByDocumentIdAndStatuses(int $documentId, array<string|int, mixed> $statuses[, int $limit = 1 ]) : MemberCollection
Parameters
$documentId : int
$statuses : array<string|int, mixed>
$limit : int = 1
Return values
MemberCollection

listByDocumentIdAndMemberStatusesAndCustomFilter()

public listByDocumentIdAndMemberStatusesAndCustomFilter(int $documentId, array<string|int, MemberStatus::*> $memberStatuses, ConditionTree $filter[, int $limit = 0 ]) : MemberCollection
Parameters
$documentId : int
$memberStatuses : array<string|int, MemberStatus::*>
$filter : ConditionTree
$limit : int = 0
Return values
MemberCollection

listByDocumentIdAndRoleAndStatus()

public listByDocumentIdAndRoleAndStatus(int $documentId, string $role[, int $limit = 0 ][, array<string|int, mixed> $statuses = [] ]) : MemberCollection
Parameters
$documentId : int
$role : string
$limit : int = 0
$statuses : array<string|int, mixed> = []
Return values
MemberCollection

listByDocumentIdListAndRoles()

public listByDocumentIdListAndRoles(array<string|int, mixed> $documentIds, array<string|int, mixed> $roles) : MemberCollection
Parameters
$documentIds : array<string|int, mixed>
$roles : array<string|int, mixed>
Return values
MemberCollection

listByDocumentIdWithRole()

public listByDocumentIdWithRole(int $documentId, string $role[, int $limit = 0 ][, int $offset = 0 ]) : MemberCollection
Parameters
$documentId : int
$role : string
$limit : int = 0
$offset : int = 0
Return values
MemberCollection

listByDocumentIdWithRoles()

public listByDocumentIdWithRoles(int $documentId, array<string|int, mixed> $memberRoles) : MemberCollection
Parameters
$documentId : int
$memberRoles : array<string|int, mixed>
Return values
MemberCollection

listByDocumentIdWithRolesAndStatuses()

public listByDocumentIdWithRolesAndStatuses(int $documentId, array<int, Role> $memberRoles, array<int, MemberStatus::*> $memberStatuses) : MemberCollection
Parameters
$documentId : int
$memberRoles : array<int, Role>
$memberStatuses : array<int, MemberStatus::*>
Return values
MemberCollection

listByDocumentIdWithStatuses()

public listByDocumentIdWithStatuses(int $documentId, array<int, MemberStatus::*> $memberStatuses) : MemberCollection
Parameters
$documentId : int
$memberStatuses : array<int, MemberStatus::*>
Return values
MemberCollection

listMembersByDocumentIdAndUserIds()

public listMembersByDocumentIdAndUserIds(int $documentId, int $representativeId, int ...$userIds) : MemberCollection
Parameters
$documentId : int
$representativeId : int
$userIds : int
Return values
MemberCollection

listUserIdsByDocumentId()

public listUserIdsByDocumentId(int $documentId) : array<int, int>
Parameters
$documentId : int
Return values
array<int, int>

listUserIdsWithEmployeeIdIsNotSetByDocumentId()

public listUserIdsWithEmployeeIdIsNotSetByDocumentId(int $documentId[, int|null $representativeId = null ]) : array<string|int, int>
Parameters
$documentId : int
$representativeId : int|null = null
Tags
throws
ArgumentException
throws
SystemException
Return values
array<string|int, int>

updateMembersReminderTypeByRole()

public updateMembersReminderTypeByRole(int $documentId, string $memberRole, ReminderType $reminderType) : Result
Parameters
$documentId : int
$memberRole : string
$reminderType : ReminderType
Return values
Result 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results