getCounttop
Description
Requires administrator permissions.
int getCount()
Return Values
| int |
getSoaCollectionPagetop
Description
Gets a single SoaCollection page.
Requires administrator permissions.
For valid filters and qualifiers see getValidSoaCollectionFilters().
BannerEventList getSoaCollectionPage(KeySetPagedSoaCollectionConfiguration $configuration)
Parameters
| KeySetPagedSoaCollectionConfiguration | $configuration |
Return Values
| BannerEventList |
getValidSoaCollectionFilterstop
Description
Gets valid soa collection search filters and their qualifier name / values
SoaCollectionValidFilterList getValidSoaCollectionFilters()
Return Values
| SoaCollectionValidFilterList |
logintop
Description
Initializes a new session with given information
boolean login(string $user, string $pass, int $network)
Parameters
| string | $user | Username |
| string | $pass | Password |
| int | $network | $network Network ID |
Return Values
| boolean | true on success, false on fail |
logouttop
Description
Destroys the active session, logging out the user.
boolean logout()
Return Values
| boolean | true on success, false on fail |
BannerEventtop
Definition
- - int $id
-
optional
- - string $name
-
required
- - string $key
-
required
- - string $description
-
optional
- - boolean $active
-
required
- - string $createdAt
-
optional
- - string $updatedAt
-
optional
BannerEventListtop
Definition
- - Array <BannerEvent> $bannerEvents
-
optional
- - Array <NamedStringValue> $lastKeySet
-
optional
KeySetPagedSoaCollectionConfigurationtop
Definition
- - Array <SoaCollectionFilter> $filters
-
optional
See SoaCollection::addQualifiedFilter()
- - int $pageSize
-
required
- - Array <NamedStringValue> $lastKeySet
-
optional
Read-only specification of the last collection element for key-set based paging.
The value is an implementation detail and must only be used for passing it directly
to getSoaCollectionPage() in order to navigate to the next collection page.
The value must be retrieved from the "lastKeySet" property of the previous getSoaCollectionPage() call.
To be left empty for the very first getSoaCollectionPage() call (default). - - boolean $useReplication
-
optional
Enables usage of replicated data increasing the performance and stability of search operations.
Regardless of this setting live data will be used instead in case of replication having
a lag of more than a couple of seconds.
NamedStringValuetop
Definition
- - string $name
-
required
- - string $value
-
required
SoaCollectionFiltertop
Definition
See SoaCollection::addQualifiedFilter().
- - string $target
-
required
- - string $value
-
required
- - int $qualifier
-
required
SoaCollectionFilterQualifiertop
Definition
Describes the possible qualifiers for a filter target
- - string $name
-
required
- - int $value
-
required
SoaCollectionValidFiltertop
Definition
Describes the possible qualifiers for a filter target
- - string $target
-
required
- - Array <SoaCollectionFilterQualifier> $qualifiers
-
optional
SoaCollectionValidFilterListtop
Definition
A list of valid filters and their qualifiers