Bitrix API

Rest extends Base

Table of Contents

Constants

ID  = 'rest'

Properties

$langFields  : mixed

Methods

canUse()  : bool
Check can use state of provider.
className()  : mixed
getDefaultFrom()  : null|string
Get default From.
getExternalId()  : mixed
getFirstFromList()  : mixed|null
getFromList()  : array<string|int, mixed>
getId()  : string
getManageUrl()  : mixed
getName()  : string
getShortName()  : string
getType()  : mixed
isConfigurable()  : mixed
isCorrectFrom()  : bool
isSupported()  : bool
prepareMessageBodyForSave()  : string
Prepares text for message body.
resolveStatus()  : int
Converts service status to internal status
sendMessage()  : SendMessage
sendTemplate()  : Result
setSocketTimeout()  : Base
setStreamTimeout()  : Base

Constants

ID

public mixed ID = 'rest'

Properties

$langFields

public static mixed $langFields

Methods

canUse()

Check can use state of provider.

public canUse() : bool
Return values
bool

className()

public static className() : mixed

getDefaultFrom()

Get default From.

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

getExternalId()

public getExternalId() : mixed

getFirstFromList()

public getFirstFromList() : mixed|null
Return values
mixed|null

getFromList()

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

getId()

public getId() : string
Return values
string

getManageUrl()

public getManageUrl() : mixed

getName()

public getName() : string
Return values
string

getShortName()

public getShortName() : string
Return values
string

getType()

public getType() : mixed

isConfigurable()

public isConfigurable() : mixed

isCorrectFrom()

public isCorrectFrom(mixed $from) : bool
Parameters
$from : mixed
Return values
bool

isSupported()

public static isSupported() : bool
Return values
bool

prepareMessageBodyForSave()

Prepares text for message body.

public prepareMessageBodyForSave(string $text) : string
Parameters
$text : string
Return values
string

resolveStatus()

Converts service status to internal status

public static resolveStatus(mixed $serviceStatus) : int
Parameters
$serviceStatus : mixed
Return values
int

sendMessage()

public sendMessage(array<string|int, mixed> $messageFields) : SendMessage
Parameters
$messageFields : array<string|int, mixed>
Return values
SendMessage —

Send operation result.

sendTemplate()

public sendTemplate(string $name, string $text[, array<string|int, mixed> $examples = [] ][, string|null $langCode = null ]) : Result
Parameters
$name : string
$text : string
$examples : array<string|int, mixed> = []
$langCode : string|null = null
Return values
Result

setSocketTimeout()

public setSocketTimeout(int $socketTimeout) : Base
Parameters
$socketTimeout : int
Return values
Base

setStreamTimeout()

public setStreamTimeout(int $streamTimeout) : Base
Parameters
$streamTimeout : int
Return values
Base 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results