UserdefinedTag WSDL
Model class managing an userdefined tagThis service is stateful.
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 UserdefinedTag
int add()
Return Values
| int | The ID of the UserdefinedTag (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 UserdefinedTag
boolean edit()
Return Values
| boolean | TRUE on succes, FALSE on fail |
getAreastop
Description
Returns all allowed Business Object types (area names) for the tag (names)
string getAreas()
Return Values
| string | $ar$areaNameseas |
getContenttop
Description
Returns the content for a given area as string
string getContent(string $area, string $parent_id)
Parameters
| string | $area | |
| string | $parent_id |
Return Values
| string | $content |
getDescriptiontop
Description
Returns the userdefined tag description
string getDescription()
Return Values
| string | $description |
getFormattop
Description
Returns the userdefined tag format
string getFormat()
Return Values
| string | $description |
getIdtop
Description
Returns the userdefined tag id
int getId()
Return Values
| int | $id |
getIdsByAreatop
Description
Finds all tag Ids for a business Object defined by type and id
string getIdsByArea(string $area)
Parameters
| string | $area |
Return Values
| string |
getLengthtop
Description
Returns the userdefined tag max length
int getLength()
Return Values
| int | $length |
getNametop
Description
Returns the userdefined tag name
string getName()
Return Values
| string | $name |
getNetworktop
Description
Returns the current network id
int getNetwork()
Return Values
| int | Network ID |
getNetworkIdtop
Description
Returns the Network id for the tag
int getNetworkId()
Return Values
| int |
getPositiontop
Description
Returns the userdefined tag position
int getPosition()
Return Values
| int | $position |
getReportabletop
Description
Returns the userdefined tag reportable flag
boolean getReportable()
Return Values
| boolean | $reportable |
getTokentop
Description
Gets the session token. Can be used for single-sign-on.
string getToken()
Return Values
| string |
getTypetop
Description
Returns the userdefined tag type (custom/system)
boolean getType()
Return Values
| boolean | $type |
loadtop
Description
Loads a user defined tag
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 |
savetop
Description
Persists current object state
boolean save()
Return Values
| boolean |
setAreastop
Description
Sets allowed areas by name
boolean setAreas(string $areas)
Parameters
| string | $areas |
Return Values
| boolean | Returns TRUE on success or FALSE on failure. |
setContenttop
Description
Sets the content of the tag in a business object context
boolean setContent(string $area, int $parent_id, string $content)
Parameters
| string | $area | |
| int | $parent_id | |
| string | $content |
Return Values
| boolean |
setDescriptiontop
Description
Sets the container tag description
boolean setDescription(string $description)
Parameters
| string | $description |
Return Values
| boolean | Returns TRUE on success or FALSE on failure. |
setFormattop
Description
Sets the container tag format
boolean setFormat(string $format)
Parameters
| string | $format |
Return Values
| boolean | Returns TRUE on success or FALSE on failure. |
setLengthtop
Description
Sets the container tag max length
boolean setLength(int $length)
Parameters
| int | $length |
Return Values
| boolean | Returns TRUE on success or FALSE on failure. |
setNametop
Description
Sets the container tag name
boolean setName(string $name)
Parameters
| string | $name |
Return Values
| boolean | Returns TRUE on success or FALSE on failure. |
setPositiontop
Description
Sets the container tag position
boolean setPosition(int $position)
Parameters
| int | $position |
Return Values
| boolean | Returns TRUE on success or FALSE on failure. |
setReportabletop
Description
Sets the container tag reportable flag
boolean setReportable(boolean $reportable)
Parameters
| boolean | $reportable |
Return Values
| boolean | Returns TRUE on success or FALSE on failure. |
validatetop
Description
Validates the object and returns an error stack.
string validate()
Return Values
| string |