BannerEvent WSDL
BannerEvents can be used to trigger certain Custom Events.This service is stateful.
Examples +
- create
- create
- edit
- edit
- read
- read
addtop
Deprecated 2011-01-01
This method will be removed in upcoming releases.
Use save() to persist a new entity
Description
Saves changes made to the BannerEvent
int add()
Return Values
| int | The ID of the BannerEvent (unique) |
clearObjectDatatop
Description
Clears the current object state.
This method will unload possibly loaded objects. Unsaved changes will be lost.
boolean clearObjectData()
Return Values
| boolean |
doComplexCalltop
Description
Execute a complex call.
For further information read the API-User documentation.
string doComplexCall(string $xmlstr)
Parameters
| string | $xmlstr | XML of Complex Statements |
Return Values
| string | The output produced by the statements |
edittop
Deprecated 2011-01-01
This method will be removed in upcoming releases.
Use save() to persist changes made to an entity
Description
Saves changes made to the BannerEvent
boolean edit()
Return Values
| boolean | TRUE on succes, FALSE on fail |
getDescriptiontop
Description
Gets the BannerEvent description.
string getDescription()
Return Values
| string |
getIdtop
Description
Gets the BannerEvent id.
int getId()
Return Values
| int |
getKeytop
Description
Gets the BannerEvent key.
string getKey()
Return Values
| string |
getNametop
Description
Gets the BannerEvent name.
string getName()
Return Values
| string |
getNetworktop
Description
Returns the current network id
int getNetwork()
Return Values
| int | Network ID |
getNetworkIdtop
Deprecated 2011-01-01
This method will be removed in upcoming releases.
Description
Returns the current network id. Alias for getNetwork()
int getNetworkId()
Return Values
| int | Network ID |
getTokentop
Description
Gets the session token. Can be used for single-sign-on.
string getToken()
Return Values
| string |
isActivetop
Description
Activates / deactivates the BannerEvent active state.
boolean isActive()
Return Values
| boolean |
loadtop
Description
For loading a BannerEvent Model.
boolean load(int $id)
Parameters
| int | $id |
Return Values
| boolean | True on success, otherwise false |
loadByKeytop
Description
For loading a BannerEvent by a given BannerEvent key.
int loadByKey(string $key)
Parameters
| string | $key |
Return Values
| int |
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 |
loginSmartPhonetop
Deprecated 2014-12-22
This method will be removed in upcoming releases.
Was only useful for the mobile app, which is not supported anymore.
Description
Login method
boolean loginSmartPhone(string $user, string $pass, int $network, string $client)
Parameters
| string | $user | Username |
| string | $pass | Password |
| int | $network | $network Network ID |
| string | $client | Client token e.g. "apn" token of iPhone |
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 |
savetop
Description
Persist a given BannerEvent Entity.
int save()
Return Values
| int |
setActivetop
Description
Sets the BannerEvent active state.
boolean setActive(boolean $active)
Parameters
| boolean | $active |
Return Values
| boolean |
setDescriptiontop
Description
Sets the BannerEvent description.
boolean setDescription(string $description)
Parameters
| string | $description |
Return Values
| boolean |
setKeytop
Description
Sets the BannerEvent key.
boolean setKey(string $key)
Parameters
| string | $key |
Return Values
| boolean |
setNametop
Description
Sets the BannerEvent name.
boolean setName(string $name)
Parameters
| string | $name |
Return Values
| boolean |
validatetop
Description
Validates the object and returns an error stack.
string validate()
Return Values
| string |