Channel WSDL
A channel, often called categoryThis 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 Channel
int add()
Return Values
| int | The ID of the Channel (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 Channel
boolean edit()
Return Values
| boolean | TRUE on succes, FALSE on fail |
getIdtop
Description
Gets the ID of the channel
int getId()
Return Values
| int |
getNametop
Description
Gets the name of the channel
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 of the channel.
int getNetworkId()
Return Values
| int |
getParenttop
Description
Gets the parent channel
int getParent()
Return Values
| int |
getParentIdtop
Description
Gets the parent ID of the channel
int getParentId()
Return Values
| int |
getTokentop
Description
Gets the session token. Can be used for single-sign-on.
string getToken()
Return Values
| string |
hasChildrentop
Description
Checks if the channel has child
boolean hasChildren()
Return Values
| boolean |
isRootChanneltop
Description
Checks if the channel is a root-level channel
boolean isRootChannel()
Return Values
| boolean | TRUE if the channel is a root channel, otherwise FALSE |
loadtop
Description
Load a specific Channel
boolean load(int $id)
Parameters
| int | $id |
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 channel
boolean remove()
Return Values
| boolean |
removeByIdtop
Description
Removes a ChannelModel with the given id
boolean removeById(int $id)
Parameters
| int | $id | ID of object to remove. |
Return Values
| boolean |
removeParenttop
Description
Removes the parent
boolean removeParent()
Return Values
| boolean | True on success, otherwise false |
savetop
Description
Persists current object state
boolean save()
Return Values
| boolean |
setNametop
Description
Sets the name of the channel
boolean setName(string $name)
Parameters
| string | $name |
Return Values
| boolean |
setParenttop
Description
Sets the parent of the channel
boolean setParent(int $parent)
Parameters
| int | $parent |
Return Values
| boolean | True on success, otherwise false |
setParentIdtop
Description
Sets the parent id of the channel.
boolean setParentId(int $parent_id)
Parameters
| int | $parent_id |
Return Values
| boolean | True on success, otherwise false |
validatetop
Description
Validates the object and returns an error stack.
string validate()
Return Values
| string |