Bitrix API

Link implements Item

Table of Contents

Interfaces

Item

Constants

ROLE_ASSIGNEE  = 'assignee'
ROLE_EDITOR  = 'editor'
ROLE_REVIEWER  = 'reviewer'
ROLE_SIGNER  = 'signer'
STATE_CONTINUE_WEB_ASSIGNEE  = 'GO_TO_WEB'
STATE_CONTINUE_WEB_EDITOR  = 'GO_TO_WEB_EDITOR'
STATE_DOCUMENT_STOPPED  = 'REFUSED'
STATE_MEMBER_ASSIGNEE_SIGNED  = 'SIGNED_BY_ASSIGNEE'
STATE_MEMBER_EDITOR_SIGNED  = 'SIGNED_BY_EDITOR'
STATE_MEMBER_PROCESSING_WAITING  = 'PROCESSING_WAITING'
STATE_MEMBER_READY_FOR_DOWNLOAD  = 'SIGNED'
STATE_MEMBER_READY_FOR_DOWNLOAD_DOCUMENT_STOPPED  = 'REFUSED_BY_ASSIGNEE'
STATE_MEMBER_REVIEWER_SIGNED  = 'REVIEW_SUCCESS'
STATE_MEMBER_SIGNED  = 'PROCESSING'
STATE_MEMBER_STOPPED  = 'REFUSED_SELF'

Properties

$documentTitle  : string|null
$memberId  : int|null
$url  : string|null

Methods

__construct()  : mixed
canBeConfirmed()  : bool
Verify that the deferred confirmation is still relevant or needs to be skipped
getDocumentSigningState()  : string|null
Various stubs and empty states
getInitiatedByType()  : string
getRole()  : string
Used to display texts by role
isExternal()  : bool
isGoskey()  : bool
isGoskeyAssigneeAlmostDone()  : bool
isReadyForSigningOnMobile()  : bool
Verify that this signing can be opened in mobile app
setGoskeyAssigneeAlmostDone()  : self

Constants

ROLE_ASSIGNEE

public mixed ROLE_ASSIGNEE = 'assignee'

ROLE_EDITOR

public mixed ROLE_EDITOR = 'editor'

ROLE_REVIEWER

public mixed ROLE_REVIEWER = 'reviewer'

ROLE_SIGNER

public mixed ROLE_SIGNER = 'signer'

STATE_CONTINUE_WEB_ASSIGNEE

public mixed STATE_CONTINUE_WEB_ASSIGNEE = 'GO_TO_WEB'

STATE_CONTINUE_WEB_EDITOR

public mixed STATE_CONTINUE_WEB_EDITOR = 'GO_TO_WEB_EDITOR'

STATE_DOCUMENT_STOPPED

public mixed STATE_DOCUMENT_STOPPED = 'REFUSED'

STATE_MEMBER_ASSIGNEE_SIGNED

public mixed STATE_MEMBER_ASSIGNEE_SIGNED = 'SIGNED_BY_ASSIGNEE'

STATE_MEMBER_EDITOR_SIGNED

public mixed STATE_MEMBER_EDITOR_SIGNED = 'SIGNED_BY_EDITOR'

STATE_MEMBER_PROCESSING_WAITING

public mixed STATE_MEMBER_PROCESSING_WAITING = 'PROCESSING_WAITING'

STATE_MEMBER_READY_FOR_DOWNLOAD

public mixed STATE_MEMBER_READY_FOR_DOWNLOAD = 'SIGNED'

STATE_MEMBER_READY_FOR_DOWNLOAD_DOCUMENT_STOPPED

public mixed STATE_MEMBER_READY_FOR_DOWNLOAD_DOCUMENT_STOPPED = 'REFUSED_BY_ASSIGNEE'

STATE_MEMBER_REVIEWER_SIGNED

public mixed STATE_MEMBER_REVIEWER_SIGNED = 'REVIEW_SUCCESS'

STATE_MEMBER_SIGNED

public mixed STATE_MEMBER_SIGNED = 'PROCESSING'

STATE_MEMBER_STOPPED

public mixed STATE_MEMBER_STOPPED = 'REFUSED_SELF'

Properties

$documentTitle

public string|null $documentTitle = null

$memberId

public int|null $memberId = null

$url

public string|null $url

Methods

__construct()

public __construct(string|null $url[, string|null $documentTitle = null ][, int|null $memberId = null ][, string|null $role = null ][, string|null $status = null ][, string|null $documentStatus = null ][, string|null $providerCode = null ][, bool $readyForDownload = false ][, InitiatedByType|null $initiatedByType = null ]) : mixed
Parameters
$url : string|null
$documentTitle : string|null = null
$memberId : int|null = null
$role : string|null = null
$status : string|null = null
$documentStatus : string|null = null
$providerCode : string|null = null
$readyForDownload : bool = false
$initiatedByType : InitiatedByType|null = null

canBeConfirmed()

Verify that the deferred confirmation is still relevant or needs to be skipped

public canBeConfirmed() : bool
Return values
bool

getDocumentSigningState()

Various stubs and empty states

public getDocumentSigningState() : string|null
Return values
string|null

getInitiatedByType()

public getInitiatedByType() : string
Return values
string

getRole()

Used to display texts by role

public getRole() : string
Return values
string

isExternal()

public isExternal() : bool
Return values
bool

isGoskey()

public isGoskey() : bool
Return values
bool

isGoskeyAssigneeAlmostDone()

public isGoskeyAssigneeAlmostDone() : bool
Return values
bool

isReadyForSigningOnMobile()

Verify that this signing can be opened in mobile app

public isReadyForSigningOnMobile() : bool
Return values
bool

setGoskeyAssigneeAlmostDone()

public setGoskeyAssigneeAlmostDone() : self
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results