Agent
Class Agent For periodically exchange data with sftp.
Table of Contents
Methods
- add() : bool|int
- start() : string
- Starts data exchange.
- update() : array<string|int, mixed>
- Update agent's params.
Methods
add()
public
static add(mixed $feedType, mixed $siteId, mixed $interval[, bool|false $once = false ]) : bool|int
Parameters
- $feedType : mixed
- $siteId : mixed
- $interval : mixed
- $once : bool|false = false
Tags
Return values
bool|intstart()
Starts data exchange.
public
static start(mixed $feedType, mixed $siteId[, string $startPosition = "" ][, bool|false $once = false ]) : string
Parameters
- $feedType : mixed
- $siteId : mixed
- $startPosition : string = ""
- $once : bool|false = false
Tags
Return values
stringupdate()
Update agent's params.
public
static update(string $siteId, array<string|int, mixed> $feedSettings) : array<string|int, mixed>
Parameters
- $siteId : string
-
Site id.
- $feedSettings : array<string|int, mixed>
-
Feed settings.
Return values
array<string|int, mixed> —Feed settings with renew agents ids.