Share WSDL
The share modelThis 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 Share
int add()
Return Values
| int | The ID of the Share (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 Share
boolean edit()
Return Values
| boolean | TRUE on succes, FALSE on fail |
getCompanytop
Description
Get company
int getCompany()
Return Values
| int |
getCompanyIdtop
Description
GetCompanyId
int getCompanyId()
Return Values
| int |
getContentunittop
Description
Get contentunit
int getContentunit()
Return Values
| int | $contentunit |
getContentunitIdtop
Description
GetContentunitId
int getContentunitId()
Return Values
| int |
getContentunitgrouptop
Deprecated 2019-03-05
This method will be removed in upcoming releases.
Managing shares for contentunit groups was never supported.
Description
Get contentunitgroup
int getContentunitgroup()
Return Values
| int | $contentunitgroup |
getContentunitgroupIdtop
Deprecated 2019-03-05
This method will be removed in upcoming releases.
Managing shares for contentunit groups was never supported.
Description
GetContentunitgroupId
int getContentunitgroupId()
Return Values
| int |
getDescriptiontop
Description
GetDescription
string getDescription()
Return Values
| string |
getIdtop
Description
GetId
int getId()
Return Values
| int |
getLoadedTimelineEntrytop
Description
GetLoadedTimelineEntry
string getLoadedTimelineEntry()
Return Values
| string |
getNetworktop
Description
Returns the current network id
int getNetwork()
Return Values
| int | Network ID |
getNetworkIdtop
Description
GetNetworkId
int getNetworkId()
Return Values
| int |
getTimelineBetweentop
Description
Get the timeline between two dates
string getTimelineBetween(string $start, string $end)
Parameters
| string | $start | |
| string | $end |
Return Values
| string |
getTokentop
Description
Gets the session token. Can be used for single-sign-on.
string getToken()
Return Values
| string |
getWebsitetop
Description
Get website
int getWebsite()
Return Values
| int | $website |
getWebsiteIdtop
Description
GetWebsiteId
int getWebsiteId()
Return Values
| int |
loadtop
Description
Load a Share Object by ID
boolean load(int $id)
Parameters
| int | $id |
Return Values
| boolean | True on success, otherwise false |
loadByParenttop
Description
Load the share by its parent
int loadByParent(int $id, string $type)
Parameters
| int | $id | |
| string | $type | $type |
Return Values
| int |
loadTimelineEntryForDatetop
Description
Load the timeline entry for the given date
boolean loadTimelineEntryForDate(string $date)
Parameters
| string | $date |
Return Values
| boolean |
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 the share
boolean remove()
Return Values
| boolean | True on success, otherwise false |
removeByIdtop
Description
Removes a ShareModel 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 | True on success, otherwise false |
setCompanytop
Description
Set company
boolean setCompany(int $company)
Parameters
| int | $company |
Return Values
| boolean |
setCompanyIdtop
Description
SetCompanyId
boolean setCompanyId(int $company_id)
Parameters
| int | $company_id | The $companyId to set |
Return Values
| boolean |
setContentunittop
Description
Set contentunit
boolean setContentunit(int $contentunit)
Parameters
| int | $contentunit |
Return Values
| boolean |
setContentunitIdtop
Description
SetContentunitId
boolean setContentunitId(int $contentunit_id)
Parameters
| int | $contentunit_id | The $contentunit_id to set |
Return Values
| boolean |
setContentunitgrouptop
Deprecated 2019-03-05
This method will be removed in upcoming releases.
Managing shares for contentunit groups was never supported.
Description
Set contentunitgroup
boolean setContentunitgroup(int $contentunitgroup)
Parameters
| int | $contentunitgroup |
Return Values
| boolean |
setContentunitgroupIdtop
Deprecated 2019-03-05
This method will be removed in upcoming releases.
Managing shares for contentunit groups was never supported.
Description
SetContentunitgroupId
boolean setContentunitgroupId(int $contentunitgroup_id)
Parameters
| int | $contentunitgroup_id | The $contentunitgroup_id to set |
Return Values
| boolean |
setDescriptiontop
Description
SetDescription
boolean setDescription(string $description)
Parameters
| string | $description |
Return Values
| boolean |
setWebsitetop
Description
Set website
boolean setWebsite(int $website)
Parameters
| int | $website |
Return Values
| boolean |
setWebsiteIdtop
Description
SetWebsiteId
boolean setWebsiteId(int $website_id)
Parameters
| int | $website_id | The $website_id to set |
Return Values
| boolean |
validatetop
Description
Validates the object and returns an error stack.
string validate()
Return Values
| string |