Bitrix API

Service implements IService, IMultiClientService, IInternalService

Table of Contents

Interfaces

IService
IMultiClientService
IInternalService

Constants

GROUP  = 'analytics'
TYPE_FACEBOOK  = 'facebook'
TYPE_GOOGLE  = 'google'
TYPE_INSTAGRAM  = 'instagram'
TYPE_VKADS  = 'vkads'
TYPE_VKONTAKTE  = 'vkontakte'
TYPE_YANDEX  = 'yandex'

Methods

canUse()  : bool
Return true if it can use.
canUseAsInternal()  : bool
check if service can use as internal
canUseMultipleClients()  : bool
Can use multiple clients.
getAccount()  : Account
Get account.
getAccounts()  : array<string|int, mixed>
Get accounts.
getAuthAdapter()  : AuthAdapter
Get auth adapter.
getClientId()  : string
Get client id
getClientsProfiles()  : array<string|int, mixed>
Get client profiles.
getEngineCode()  : string
getErrors()  : array<string|int, mixed>
Get errors.
getInstance()  : static
Get instance.
getMethodPrefix()  : string
get seoproxy method prefix
getProviders()  : array<string|int, mixed>
Get providers.
getTypeByEngine()  : string|null
get type by engineCode
getTypes()  : array<string|int, mixed>
hasErrors()  : bool
Return true if it has errors.
removeAuth()  : void
Remove auth.
resetErrors()  : void
Reset errors.
setClientId()  : $this
Set client id.

Constants

GROUP

public mixed GROUP = 'analytics'

TYPE_FACEBOOK

public mixed TYPE_FACEBOOK = 'facebook'

TYPE_GOOGLE

public mixed TYPE_GOOGLE = 'google'

TYPE_INSTAGRAM

public mixed TYPE_INSTAGRAM = 'instagram'

TYPE_VKADS

public mixed TYPE_VKADS = 'vkads'

TYPE_VKONTAKTE

public mixed TYPE_VKONTAKTE = 'vkontakte'

TYPE_YANDEX

public mixed TYPE_YANDEX = 'yandex'

Methods

canUse()

Return true if it can use.

public static canUse() : bool
Return values
bool

canUseAsInternal()

check if service can use as internal

public static canUseAsInternal() : bool
Tags
inheritDoc
Return values
bool

canUseMultipleClients()

Can use multiple clients.

public static canUseMultipleClients() : bool
Return values
bool

getAccount()

Get account.

public static getAccount(string $type) : Account
Parameters
$type : string

Type.

Return values
Account

getAccounts()

Get accounts.

public static getAccounts(string $type) : array<string|int, mixed>
Parameters
$type : string

Type.

Return values
array<string|int, mixed>

getAuthAdapter()

Get auth adapter.

public static getAuthAdapter(string $type) : AuthAdapter
Parameters
$type : string

Type.

Return values
AuthAdapter

getClientId()

Get client id

public getClientId() : string
Return values
string

getClientsProfiles()

Get client profiles.

public static getClientsProfiles(AuthAdapter $authAdapter) : array<string|int, mixed>
Parameters
$authAdapter : AuthAdapter

Auth adapter.

Return values
array<string|int, mixed>

getEngineCode()

public static getEngineCode(string $type) : string
Parameters
$type : string
Return values
string

getErrors()

Get errors.

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

getInstance()

Get instance.

public static getInstance() : static
Return values
static

getMethodPrefix()

get seoproxy method prefix

public static getMethodPrefix() : string
Tags
inheritDoc
Return values
string

getProviders()

Get providers.

public static getProviders([array<string|int, mixed>|null $types = null ]) : array<string|int, mixed>
Parameters
$types : array<string|int, mixed>|null = null

Types.

Return values
array<string|int, mixed>

getTypeByEngine()

get type by engineCode

public static getTypeByEngine(string $engineCode) : string|null
Parameters
$engineCode : string
Tags
inheritDoc
Return values
string|null

getTypes()

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

hasErrors()

Return true if it has errors.

public static hasErrors() : bool
Return values
bool

removeAuth()

Remove auth.

public static removeAuth(string $type) : void
Parameters
$type : string

Type.

resetErrors()

Reset errors.

public static resetErrors() : void

setClientId()

Set client id.

public setClientId(string $clientId) : $this
Parameters
$clientId : string

Client id.

Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results