Класс RestService

Граф наследования:RestService:

Открытые статические члены
static	onRestServiceBuildDescription ()
static	onRestAppDelete (array $fields)
static	onRestAppUpdate (array $fields)
static	addSender ($params, $n, $server)
static	deleteSender ($params, $n, $server)
static	getSenderList ($params, $n, $server)
static	updateMessageStatus ($params, $n, $server)
static	getMessageStatus (array $params, int $n, CRestServer $server)

Открытые атрибуты
const	SCOPE = 'messageservice'
const	ERROR_UNSUPPORTED_PROTOCOL = 'ERROR_UNSUPPORTED_PROTOCOL'
const	ERROR_WRONG_HANDLER_URL = 'ERROR_WRONG_HANDLER_URL'
const	ERROR_HANDLER_URL_MATCH = 'ERROR_HANDLER_URL_MATCH'
const	ERROR_SENDER_ALREADY_INSTALLED = 'ERROR_SENDER_ALREADY_INSTALLED'
const	ERROR_SENDER_ADD_FAILURE = 'ERROR_SENDER_ADD_FAILURE'
const	ERROR_SENDER_VALIDATION_FAILURE = 'ERROR_SENDER_VALIDATION_FAILURE'
const	ERROR_SENDER_NOT_FOUND = 'ERROR_SENDER_NOT_FOUND'
const	ERROR_MESSAGE_NOT_FOUND = 'ERROR_MESSAGE_NOT_FOUND'
const	ERROR_MESSAGE_STATUS_INCORRECT = 'ERROR_MESSAGE_STATUS_INCORRECT'

Статические защищенные данные
static	$app

Подробное описание

См. определение в файле restservice.php строка 14

Методы

addSender()

static addSender ( $params, $n, $server )

static

Аргументы

array	$params	Input params.
int	$n	Offset.
CRestServer	$server	Rest server instance.

Возвращает

bool

Исключения

Exception

См. определение в файле restservice.php строка 97

deleteSender()

static deleteSender ( $params, $n, $server )

static

Аргументы

array	$params	Input params.
int	$n	Offset.
CRestServer	$server	Rest server instance.

Возвращает

bool

Исключения

Exception

См. определение в файле restservice.php строка 164

getMessageStatus()

static getMessageStatus ( array $params, int $n, CRestServer $server )

static

Аргументы

	array{	message_id: int } $params
int	$n
CRestServer	$server

Возвращает

string

Исключения

RestException

См. определение в файле restservice.php строка 279

getSenderList()

static getSenderList ( $params, $n, $server )

static

Аргументы

array	$params	Input params.
int	$n	Offset.
CRestServer	$server	Rest server instance.

Возвращает

array

Исключения

AccessException

Bitrix\Main\ArgumentException

См. определение в файле restservice.php строка 202

onRestAppDelete()

static onRestAppDelete ( array $fields )

static

Аргументы

array

$fields

Fields describes application.

Возвращает

void

См. определение в файле restservice.php строка 49

onRestAppUpdate()

static onRestAppUpdate ( array $fields )

static

Аргументы

array

$fields

Fields describes application.

Возвращает

void

См. определение в файле restservice.php строка 85

onRestServiceBuildDescription()

static onRestServiceBuildDescription ( )

static

См. определение в файле restservice.php строка 31

updateMessageStatus()

static updateMessageStatus ( $params, $n, $server )

static

Аргументы

array	$params	Input params.
int	$n	Offset.
CRestServer	$server	Rest server instance.

Возвращает

bool

Исключения

AccessException
RestException

См. определение в файле restservice.php строка 233

Данные класса

$app

$app	staticprotected

См. определение в файле restservice.php строка 17

ERROR_HANDLER_URL_MATCH

const ERROR_HANDLER_URL_MATCH = 'ERROR_HANDLER_URL_MATCH'

См. определение в файле restservice.php строка 21

ERROR_MESSAGE_NOT_FOUND

const ERROR_MESSAGE_NOT_FOUND = 'ERROR_MESSAGE_NOT_FOUND'

См. определение в файле restservice.php строка 28

ERROR_MESSAGE_STATUS_INCORRECT

const ERROR_MESSAGE_STATUS_INCORRECT = 'ERROR_MESSAGE_STATUS_INCORRECT'

См. определение в файле restservice.php строка 29

ERROR_SENDER_ADD_FAILURE

const ERROR_SENDER_ADD_FAILURE = 'ERROR_SENDER_ADD_FAILURE'

См. определение в файле restservice.php строка 24

ERROR_SENDER_ALREADY_INSTALLED

const ERROR_SENDER_ALREADY_INSTALLED = 'ERROR_SENDER_ALREADY_INSTALLED'

См. определение в файле restservice.php строка 23

ERROR_SENDER_NOT_FOUND

const ERROR_SENDER_NOT_FOUND = 'ERROR_SENDER_NOT_FOUND'

См. определение в файле restservice.php строка 26

ERROR_SENDER_VALIDATION_FAILURE

const ERROR_SENDER_VALIDATION_FAILURE = 'ERROR_SENDER_VALIDATION_FAILURE'

См. определение в файле restservice.php строка 25

ERROR_UNSUPPORTED_PROTOCOL

const ERROR_UNSUPPORTED_PROTOCOL = 'ERROR_UNSUPPORTED_PROTOCOL'

См. определение в файле restservice.php строка 19

ERROR_WRONG_HANDLER_URL

const ERROR_WRONG_HANDLER_URL = 'ERROR_WRONG_HANDLER_URL'

См. определение в файле restservice.php строка 20

SCOPE

const SCOPE = 'messageservice'

См. определение в файле restservice.php строка 16