Bitrix API

BoxHandler extends DocumentHandler implements CloudImportInterface

Table of Contents

Interfaces

CloudImportInterface

Constants

API_URL_V2  = 'https://api.box.com/2.0'

ERROR_BAD_JSON  = 'DISK_BOX_HANDLER_22005'

ERROR_CODE_APP_IN_BLACKLIST  = 'DISK_DOC_HANDLER_220028'

ERROR_CODE_APP_NOT_CONFIGURED  = 'DISK_DOC_HANDLER_220027'

ERROR_CODE_INSUFFICIENT_SCOPE  = 'DISK_DOC_HANDLER_220022'

ERROR_CODE_INVALID_ACCESS_LEVEL  = 'DISK_DOC_HANDLER_220026'

ERROR_CODE_INVALID_CREDENTIALS  = 'DISK_DOC_HANDLER_220023'

ERROR_CODE_NOT_FOUND  = 'DISK_DOC_HANDLER_220030'

ERROR_CODE_NOT_FOUND_ETAG  = 'DISK_DOC_HANDLER_220031'

ERROR_CODE_NOT_GRANTED_APP  = 'DISK_DOC_HANDLER_220025'

ERROR_CODE_NOT_INSTALLED_APP  = 'DISK_DOC_HANDLER_220024'

ERROR_CODE_UNKNOWN  = 'DISK_DOC_HANDLER_220029'

ERROR_COULD_NOT_FIND_ID  = 'DISK_BOX_HANDLER_22014'

ERROR_COULD_NOT_VIEW_FILE  = 'DISK_BOX_HANDLER_22013'

ERROR_HTTP_CREATE_BLANK  = 'DISK_BOX_HANDLER_22004'

ERROR_HTTP_DELETE_FILE  = 'DISK_BOX_HANDLER_22006'

ERROR_HTTP_DOWNLOAD_FILE  = 'DISK_BOX_HANDLER_22007'

ERROR_HTTP_GET_LOCATION_FOR_UPLOAD  = 'DISK_BOX_HANDLER_22009'

ERROR_HTTP_GET_METADATA  = 'DISK_BOX_HANDLER_22008'

ERROR_HTTP_INSERT_PERMISSION  = 'DISK_BOX_HANDLER_22010'

ERROR_HTTP_LIST_FOLDER  = 'DISK_BOX_HANDLER_22015'

ERROR_HTTP_RESUMABLE_UPLOAD  = 'DISK_BOX_HANDLER_22012'

ERROR_INVALID_RESPONSE_STATUS  = 'DISK_DOC_HANDLER_22002'

ERROR_METHOD_IS_NOT_SUPPORTED  = 'DISK_BOX_HANDLER_22001'

ERROR_NOT_INSTALLED_SOCSERV  = 'DISK_BOX_HANDLER_22002'

ERROR_REQUIRED_PARAMETER  = 'DISK_DOC_HANDLER_22003'

ERROR_UNSUPPORTED_FILE_FORMAT  = 'DISK_BOX_HANDLER_22003'

SPECIFIC_FOLDER_CODE  = \Bitrix\Disk\SpecificFolder::CODE_FOR_IMPORT_BOX

Methods

__construct()  : mixed

checkAccessibleTokenService()  : bool

Execute this method for check potential possibility get access token.

checkHttpResponse()  : bool

checkViewFile()  : bool|null

Check success view file in service.

className()  : string

createBlankFile()  : FileData|null

Create new blank file in cloud service.

createFile()  : FileData|null

Create file in cloud service by upload from us server.

deleteFile()  : bool

Delete file from cloud service by FileData::id

downloadFile()  : FileData|null

Download file from cloud service by FileData::id, put contents in FileData::src

downloadPartFile()  : FileData|null

Download part of file from cloud service by FileData::id, put contents in FileData::src

getAccessToken()  : string

getCode()  : string

Internal code. Identificate document handler

getConvertExtension()  : mixed

getDataForViewFile()  : string|null

Get url for showing preview file.

getErrorByCode()  : array<string|int, Error>

Getting once error with the necessary code.

getErrorContainer()  : mixed

getErrors()  : array<string|int, Error>

Getting array of errors.

getErrorsByCode()  : array<string|int, Error>

Getting array of errors with the necessary code.

getFileMetadata()  : array<string|int, mixed>|null

Gets a file's metadata by ID.

getName()  : string

Public name document handler. May show in user interface.

getStorageName()  : string

Public name storage of documents. May show in user interface.

getUrlForAuthorizeInTokenService()  : string

Return link for authorize user in external service.

getUserId()  : int

Returns user id.

hasAccessToken()  : bool

isEditable()  : bool

Detect by extension editable or not

isNeedConvertExtension()  : bool

Detect by extension needle or not convert? We work with latest office

isRequiredAuthorization()  : bool

Need re-run oauth authorization?

listEditableExtensions()  : array<string|int, mixed>

listFolder()  : mixed

Lists folder contents

queryAccessToken()  : $this

Request and store access token (self::accessToken) for self::userId

setUserId()  : int

Sets user id.

wasChangedAfterCreation()  : bool

Tells if file in cloud service was changed. For example, the method compares created date and modified date.