FilterClusterGroup WSDL
Class for grouping inventoried (global) filters.Used only for a better frontend overview.
Required network feature activation:
- filter cluster
- retargeting or inventoried (global) filters
Requires admin privileges for save()/remove()
This service is stateful.
Examples +
- create
- create
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 FilterClusterGroup
int add()
Return Values
| int | The ID of the FilterClusterGroup (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 FilterClusterGroup
boolean edit()
Return Values
| boolean | TRUE on succes, FALSE on fail |
getChangedtop
Description
Gets the changed
string getChanged()
Return Values
| string |
getCreatedtop
Description
Gets the created
string getCreated()
Return Values
| string |
getDescriptiontop
Description
Gets the description
string getDescription()
Return Values
| string |
getIdtop
Description
Get the id
int getId()
Return Values
| int |
getNametop
Description
Get the name
string getName()
Return Values
| string |
getNetworktop
Description
Returns the current network id
int getNetwork()
Return Values
| int | Network ID |
getNetworkIdtop
Description
Gets the Network id
int getNetworkId()
Return Values
| int |
getTokentop
Description
Gets the session token. Can be used for single-sign-on.
string getToken()
Return Values
| string |
loadtop
Description
Load a filter cluster group
boolean load(int $identifier)
Parameters
| int | $identifier |
Return Values
| boolean | True on success, otherwise false |
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 |
removetop
Description
Remove a filter cluster group
boolean remove()
Return Values
| boolean |
removeByIdtop
Description
Removes a FilterClusterGroupModel with the given id
boolean removeById(int $id)
Parameters
| int | $id | ID of object to remove. |
Return Values
| boolean |
savetop
Description
Persists current object state
boolean save()
Return Values
| boolean |
setDescriptiontop
Description
Set the description
boolean setDescription(string $description)
Parameters
| string | $description | The description |
Return Values
| boolean | True on success, otherwise false |
setNametop
Description
Set the name
boolean setName(string $name)
Parameters
| string | $name | The name of the filter cluster |
Return Values
| boolean | True on success, otherwise false |
validatetop
Description
Validates the object and returns an error stack.
string validate()
Return Values
| string |