Bitrix API

Storage

Table of Contents

Methods

getApiEndpoint()  : string
getB2eMySafeUrl()  : string
getBitrixServiceAddress()  : string|null
getClientId()  : string|null
getClientToken()  : string|null
getFieldsFillMembersLimit()  : int
getImagesCountLimitForBlankUpload()  : int
getLanguages()  : array<string|int, mixed>
getLicenseToken()  : string
getProfileSafeUrl()  : string
getSavedDomain()  : string|null
getSelfAddress()  : string|null
getSelfHost()  : string|null
getServiceAddress()  : string|null
getServiceSignLink()  : string
getUploadDocumentMaxSize()  : int
getUploadImagesMaxSize()  : int
getUploadTotalMaxSize()  : int
instance()  : self
isAvailable()  : bool
isB2eAvailable()  : bool
isBlankExportAllowed()  : bool
isEdoRegion()  : bool
isNewSignEnabled()  : bool
isToursDisabled()  : bool
makeCallbackUri()  : string
setClientId()  : self
setClientToken()  : self
setCurrentDomain()  : void

Methods

getApiEndpoint()

public getApiEndpoint() : string
Return values
string

getBitrixServiceAddress()

public getBitrixServiceAddress([string|null $region = null ]) : string|null
Parameters
$region : string|null = null
Return values
string|null

getClientId()

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

getClientToken()

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

getFieldsFillMembersLimit()

public getFieldsFillMembersLimit() : int
Return values
int

getImagesCountLimitForBlankUpload()

public getImagesCountLimitForBlankUpload() : int
Return values
int

getLanguages()

public getLanguages() : array<string|int, mixed>
Return values
array<string|int, mixed>

getLicenseToken()

public getLicenseToken() : string
Return values
string

getSavedDomain()

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

getSelfAddress()

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

getSelfHost()

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

getServiceAddress()

public getServiceAddress([string|null $region = null ]) : string|null
Parameters
$region : string|null = null
Return values
string|null
public getServiceSignLink([string $docHash = '' ][, string $memberHash = '' ][, string|null $region = null ]) : string
Parameters
$docHash : string = ''
$memberHash : string = ''
$region : string|null = null
Return values
string

getUploadDocumentMaxSize()

public getUploadDocumentMaxSize() : int
Return values
int

size in bytes

getUploadImagesMaxSize()

public getUploadImagesMaxSize() : int
Return values
int

size in bytes

getUploadTotalMaxSize()

public getUploadTotalMaxSize() : int
Return values
int

size in bytes

instance()

public static instance() : self
Return values
self

isAvailable()

public isAvailable([string|null $region = null ]) : bool
Parameters
$region : string|null = null
Return values
bool

isB2eAvailable()

public isB2eAvailable([string|null $region = null ]) : bool
Parameters
$region : string|null = null
Return values
bool

isBlankExportAllowed()

public isBlankExportAllowed() : bool
Return values
bool

isEdoRegion()

public isEdoRegion([string|null $regionCode = null ]) : bool
Parameters
$regionCode : string|null = null
Return values
bool

isNewSignEnabled()

public isNewSignEnabled() : bool
Return values
bool

isToursDisabled()

public isToursDisabled() : bool
Return values
bool

makeCallbackUri()

public makeCallbackUri() : string
Return values
string

setClientId()

public setClientId(string $id) : self
Parameters
$id : string
Return values
self

setClientToken()

public setClientToken(string $token) : self
Parameters
$token : string
Return values
self

setCurrentDomain()

public setCurrentDomain(string $currentDomain) : void
Parameters
$currentDomain : string

        
On this page

Search results