CallList extends IRestService
Table of Contents
Constants
- ACCESS_ERROR = 'ACCESS_ERROR'
- ENTITIES_ERROR = 'ENTITIES_ERROR'
- ENTITY_ERROR = 'ENTITY_ERROR'
- ENTITY_TYPE_ERROR = 'ENTITY_TYPE_ERROR'
- ERROR_ARGUMENT = 'ERROR_ARGUMENT'
- LIST_ID_ERROR = 'LIST_ID_ERROR'
- STATUS_ERROR = 'STATUS_ERROR'
- WEBFORM_ERROR = 'WEBFORM_ERROR'
Methods
- addCallList() : int
- Add new call list with the permission check for each of the participants
- getCallList() : array<string|int, mixed>
- Gets information about the call list without its participants
- getItems() : array<string|int, mixed>
- Gets a list of participants in the call list with the ability to filter by participant status and pagination
- getsCallList() : array<string|int, mixed>
- Gets information about call lists without its participants with the ability to select fields, sort, filter, and pagination
- getStatusList() : array<string|int, mixed>
- Gets a list of all possible statuses of participants in the call list
- register() : void
- Registering new rest methods
- updateCallList() : bool
- Adds missing participants to the call list and deletes those who aren't in the request with the permission check for each of the participants. Update web form if exist in request
Constants
ACCESS_ERROR
public
mixed
ACCESS_ERROR
= 'ACCESS_ERROR'
ENTITIES_ERROR
public
mixed
ENTITIES_ERROR
= 'ENTITIES_ERROR'
ENTITY_ERROR
public
mixed
ENTITY_ERROR
= 'ENTITY_ERROR'
ENTITY_TYPE_ERROR
public
mixed
ENTITY_TYPE_ERROR
= 'ENTITY_TYPE_ERROR'
ERROR_ARGUMENT
public
mixed
ERROR_ARGUMENT
= 'ERROR_ARGUMENT'
LIST_ID_ERROR
public
mixed
LIST_ID_ERROR
= 'LIST_ID_ERROR'
STATUS_ERROR
public
mixed
STATUS_ERROR
= 'STATUS_ERROR'
WEBFORM_ERROR
public
mixed
WEBFORM_ERROR
= 'WEBFORM_ERROR'
Methods
addCallList()
Add new call list with the permission check for each of the participants
public
static addCallList(array{ENTITY_TYPE: string, ENTITIES: array, WEBFORM_ID: int} $query, int $nav, CRestServer $server) : int
Parameters
- $query : array{ENTITY_TYPE: string, ENTITIES: array, WEBFORM_ID: int}
- $nav : int
- $server : CRestServer
Tags
Return values
intgetCallList()
Gets information about the call list without its participants
public
static getCallList(mixed $query, mixed $nav, CRestServer $server) : array<string|int, mixed>
Parameters
- $query : mixed
-
array{id: int}
- $nav : mixed
- $server : CRestServer
Tags
Return values
array<string|int, mixed>getItems()
Gets a list of participants in the call list with the ability to filter by participant status and pagination
public
static getItems(array{LIST_ID: int, FILTER: array} $query, int $nav, CRestServer $server) : array<string|int, mixed>
Parameters
- $query : array{LIST_ID: int, FILTER: array}
- $nav : int
- $server : CRestServer
Tags
Return values
array<string|int, mixed>getsCallList()
Gets information about call lists without its participants with the ability to select fields, sort, filter, and pagination
public
static getsCallList(array{select: array, filter: array, order: array} $query, int $nav, CRestServer $server) : array<string|int, mixed>
Parameters
- $query : array{select: array, filter: array, order: array}
- $nav : int
- $server : CRestServer
Tags
Return values
array<string|int, mixed>getStatusList()
Gets a list of all possible statuses of participants in the call list
public
static getStatusList(array<string|int, mixed> $query, int $nav, CRestServer $server) : array<string|int, mixed>
Parameters
- $query : array<string|int, mixed>
- $nav : int
- $server : CRestServer
Return values
array<string|int, mixed>register()
Registering new rest methods
public
static register(mixed &$bindings) : void
Parameters
- $bindings : mixed
updateCallList()
Adds missing participants to the call list and deletes those who aren't in the request with the permission check for each of the participants. Update web form if exist in request
public
static updateCallList(array{LIST_ID: int, ENTITY_TYPE: string, ENTITIES: array, WEBFORM_ID: int} $query, int $nav, CRestServer $server) : bool
Parameters
- $query : array{LIST_ID: int, ENTITY_TYPE: string, ENTITIES: array, WEBFORM_ID: int}
- $nav : int
- $server : CRestServer