Bitrix API

AdsForm extends AdsService

Class AdsForm.

Table of Contents

Methods

canUse()  : bool
Can use.
canUserEdit()  : bool
Can user edit ads form.
enableLogs()  : void
Enable logs.
exportForm()  : bool
Export form.
getAccounts()  : array<string|int, mixed>
Get accounts.
getAdsIconMap()  : array<string|int, mixed>
Return map "connector id" - "icon name" for UI-lib icon classes
getErrors()  : array<string|int, mixed>
Get logs.
getFormLinks()  : array<string|int, mixed>
Get form links.
getForms()  : array<string|int, mixed>
Get forms.
getLinkedForms()  : array<string|int, mixed>
Get linked forms.
getLogs()  : array<string|int, mixed>
Get logs.
getProviders()  : array<string|int, mixed>
Get providers.
getService()  : Service
Get Service.
getServiceTypeName()  : string
Get service type name.
getServiceTypes()  : array<string|int, mixed>
Get service types.
getTemporaryDisabledMessage()  : string
Get temporary disabled message.
hasErrors()  : bool
Return true if it has errors.
hasFormLinks()  : bool
Return true if it has form links.
importForm()  : mixed
Import form.
registerGroup()  : bool
Register group.
removeAuth()  : mixed
Remove auth.
removeGroupAuth()  : void
Remove group auth.
resetErrors()  : void
Reset errors.
unlinkForm()  : bool
Unlink form.
unRegisterGroup()  : bool
Remove group auth.

Methods

canUse()

Can use.

public static canUse() : bool
Return values
bool

canUserEdit()

Can user edit ads form.

public static canUserEdit(int $userId) : bool
Parameters
$userId : int

User ID.

Return values
bool

enableLogs()

Enable logs.

public static enableLogs() : void

exportForm()

Export form.

public static exportForm(string $type, string $accountId, int $crmFormId[, array<string|int, mixed> $parameters = array() ]) : bool
Parameters
$type : string

Type.

$accountId : string

Account ID.

$crmFormId : int

Crm form ID.

$parameters : array<string|int, mixed> = array()

Parameters.

Return values
bool

getAccounts()

Get accounts.

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

Type.

Return values
array<string|int, mixed>

getAdsIconMap()

Return map "connector id" - "icon name" for UI-lib icon classes

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

getErrors()

Get logs.

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

getFormLinks()

Get form links.

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

Crm form ID.

$type : string

Type.

Tags
throws
ArgumentException|SystemException
Return values
array<string|int, mixed>

getForms()

Get forms.

public static getForms(string $type[, string|null $accountId = null ]) : array<string|int, mixed>
Parameters
$type : string

Type.

$accountId : string|null = null

Account ID.

Return values
array<string|int, mixed>

getLinkedForms()

Get linked forms.

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

Type.

Return values
array<string|int, mixed>

getLogs()

Get logs.

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

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>

getServiceTypeName()

Get service type name.

public static getServiceTypeName(string $type) : string
Parameters
$type : string

Type.

Return values
string

getServiceTypes()

Get service types.

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

getTemporaryDisabledMessage()

Get temporary disabled message.

public static getTemporaryDisabledMessage(string $type) : string
Parameters
$type : string

Type.

Return values
string

hasErrors()

Return true if it has errors.

public static hasErrors() : bool
Return values
bool

hasFormLinks()

Return true if it has form links.

public static hasFormLinks(int $crmFormId[, string|null $type = null ]) : bool
Parameters
$crmFormId : int

Crm form ID.

$type : string|null = null

Type.

Return values
bool

importForm()

Import form.

public static importForm(string $type, string $accountId, string $serviceFormId) : mixed
Parameters
$type : string

Type.

$accountId : string

Account ID.

$serviceFormId : string

Service form ID.

Tags
throws
NotImplementedException

registerGroup()

Register group.

public static registerGroup(string $type, string $groupId) : bool
Parameters
$type : string

Type.

$groupId : string

Group ID.

Return values
bool

removeAuth()

Remove auth.

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

Type.

removeGroupAuth()

Remove group auth.

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

Type.

resetErrors()

Reset errors.

public static resetErrors() : void

unlinkForm()

Unlink form.

public static unlinkForm(int $crmFormId[, string|null $type = null ]) : bool
Parameters
$crmFormId : int

Crm form ID.

$type : string|null = null

Type.

Return values
bool

unRegisterGroup()

Remove group auth.

public static unRegisterGroup(string $type, string $groupId) : bool
Parameters
$type : string

Type.

$groupId : string

Group ID.

Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results