Bitrix API

Access

Class Access

Table of Contents

Constants

ACTION_BUY  = 'buy'
ACTION_INSTALL  = 'install'
ACTION_OPEN  = 'open'
ENTITY_COUNT  = 'count'
ENTITY_TYPE_AP_CONNECT  = 'ap_connect'
ENTITY_TYPE_APP  = 'app'
ENTITY_TYPE_APP_STATUS  = 'status'
ENTITY_TYPE_INTEGRATION  = 'integration'
ENTITY_TYPE_WEBHOOK  = 'webhook'
MODULE_ID  = 'rest'
OPTION_ACCESS_ACTIVE  = 'access_active'
OPTION_AVAILABLE_COUNT  = 'app_available_count'
OPTION_SUBSCRIPTION_AVAILABLE  = 'subscription_available'

Methods

calcUsageEntityAgent()  : string
Agent calculates usage entities
canInstallApp()  : bool
getActiveEntity()  : mixed
getAvailableCount()  : int
getHelperCode()  : string
isActiveRules()  : string
isAllowFreeApp()  : bool
isAvailable()  : bool
Check available rest api.
isAvailableAPAuthByPasswordId()  : bool
isAvailableCount()  : bool
isFeatureEnabled()  : bool
needCheckCount()  : bool
onBitrix24LicenseChange()  : mixed
reset()  : bool
Reset saved data
resetToFree()  : bool

Constants

ACTION_BUY

public mixed ACTION_BUY = 'buy'

ACTION_INSTALL

public mixed ACTION_INSTALL = 'install'

ACTION_OPEN

public mixed ACTION_OPEN = 'open'

ENTITY_COUNT

public mixed ENTITY_COUNT = 'count'

ENTITY_TYPE_AP_CONNECT

public mixed ENTITY_TYPE_AP_CONNECT = 'ap_connect'

ENTITY_TYPE_APP

public mixed ENTITY_TYPE_APP = 'app'

ENTITY_TYPE_APP_STATUS

public mixed ENTITY_TYPE_APP_STATUS = 'status'

ENTITY_TYPE_INTEGRATION

public mixed ENTITY_TYPE_INTEGRATION = 'integration'

ENTITY_TYPE_WEBHOOK

public mixed ENTITY_TYPE_WEBHOOK = 'webhook'

MODULE_ID

public mixed MODULE_ID = 'rest'

OPTION_ACCESS_ACTIVE

public mixed OPTION_ACCESS_ACTIVE = 'access_active'

OPTION_AVAILABLE_COUNT

public mixed OPTION_AVAILABLE_COUNT = 'app_available_count'

OPTION_SUBSCRIPTION_AVAILABLE

public mixed OPTION_SUBSCRIPTION_AVAILABLE = 'subscription_available'

Methods

calcUsageEntityAgent()

Agent calculates usage entities

public static calcUsageEntityAgent([bool $period = false ]) : string
Parameters
$period : bool = false
Return values
string

canInstallApp()

public static canInstallApp(array<string|int, mixed> $installAppData) : bool
Parameters
$installAppData : array<string|int, mixed>
Return values
bool

getActiveEntity()

public static getActiveEntity([mixed $force = false ]) : mixed
Parameters
$force : mixed = false

getAvailableCount()

public static getAvailableCount() : int
Tags
throws
LoaderException
Return values
int

getHelperCode()

public static getHelperCode([mixed $action = '' ][, mixed $entityType = '' ][, mixed $entityData = [] ]) : string
Parameters
$action : mixed = ''

string

$entityType : mixed = ''

string

$entityData : mixed = []

mixed

Tags
throws
LoaderException
Return values
string

isActiveRules()

public static isActiveRules() : string
Return values
string

isAllowFreeApp()

public static isAllowFreeApp(array<string|int, mixed> $freeAppData) : bool
Parameters
$freeAppData : array<string|int, mixed>
Return values
bool

isAvailable()

Check available rest api.

public static isAvailable([string $app = '' ]) : bool
Parameters
$app : string = ''
Return values
bool

isAvailableAPAuthByPasswordId()

public static isAvailableAPAuthByPasswordId(int $passwordId) : bool
Parameters
$passwordId : int
Return values
bool

isAvailableCount()

public static isAvailableCount(mixed $entityType[, mixed $entity = 0 ]) : bool
Parameters
$entityType : mixed

string static::ENTITY_TYPE_APP | static::ENTITY_TYPE_INTEGRATION

$entity : mixed = 0

mixed app code or integration id

Tags
throws
LoaderException
Return values
bool

isFeatureEnabled()

public static isFeatureEnabled() : bool
Return values
bool

needCheckCount()

public static needCheckCount() : bool
Return values
bool

onBitrix24LicenseChange()

public static onBitrix24LicenseChange(mixed $licenseType) : mixed
Parameters
$licenseType : mixed

string

reset()

Reset saved data

public static reset() : bool
Return values
bool

resetToFree()

public static resetToFree() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results