Contentserv PHP API

CSNote
in package

Tags

Table of Contents

addText()  : void
adds a text to the note
delete()  : void
deletes the note
executeWorkflowAction()  : void
executes the workflow action with the given id
getAvailableWorkflowActions()  : array<string|int, mixed>
returns the available workflow actions for this note
getComments()  : array<string|int, CSNoteComment>
returns the available comments for this note
getContextModule()  : mixed
getContextRecord()  : mixed
getContextRecordID()  : mixed
getCreationDate()  : mixed
getData()  : array<string|int, mixed>
returns the note data
getHeight()  : mixed
getID()  : mixed
getOwnerID()  : mixed
getPositionX()  : mixed
getPositionY()  : mixed
getRecord()  : object
returns the record of this api
getResponsibleID()  : mixed
getStateID()  : mixed
getSubContext()  : mixed
getType()  : mixed
getWidth()  : mixed
isDeletable()  : mixed
isEditable()  : mixed
isViewable()  : mixed
setContextModule()  : mixed
setContextRecord()  : mixed
setContextRecordID()  : mixed
setCreationDate()  : mixed
setHeight()  : mixed
setOwnerID()  : mixed
setPositionX()  : mixed
setPositionY()  : mixed
setResponsibleID()  : mixed
setSubContext()  : mixed
setType()  : mixed
setWidth()  : mixed

Methods

addText()

adds a text to the note

public addText(string $noteText, int $actionID) : void
Parameters
$noteText : string

the note text to add

$actionID : int

if set, the corresponding workflow action is executed additionally

Tags
access

public

Return values
void —

delete()

deletes the note

public delete() : void
Tags
access

public

Return values
void —

executeWorkflowAction()

executes the workflow action with the given id

public executeWorkflowAction(int $actionID) : void
Parameters
$actionID : int

the id of the action to execute

Tags
access

public

Return values
void —

getAvailableWorkflowActions()

returns the available workflow actions for this note

public getAvailableWorkflowActions() : array<string|int, mixed>
Tags
access

public

Return values
array<string|int, mixed> —

the available actions as Action-objects

getComments()

returns the available comments for this note

public getComments() : array<string|int, CSNoteComment>
Tags
access

public

Return values
array<string|int, CSNoteComment> —

the available comments with the CSNoteCommentID as Key and CSNoteComment Objects as value

getContextModule()

public getContextModule() : mixed
Tags
Return values
mixed —

getContextRecord()

public getContextRecord() : mixed
Tags
Return values
mixed —

getContextRecordID()

public getContextRecordID() : mixed
Tags
Return values
mixed —

getCreationDate()

public getCreationDate() : mixed
Tags
Return values
mixed —

getData()

returns the note data

public getData() : array<string|int, mixed>
Tags
access

public

Return values
array<string|int, mixed> —

the note data as array

getHeight()

public getHeight() : mixed
Tags
Return values
mixed —

getID()

public getID() : mixed
Tags
Return values
mixed —

getOwnerID()

public getOwnerID() : mixed
Tags
Return values
mixed —

getPositionX()

public getPositionX() : mixed
Tags
Return values
mixed —

getPositionY()

public getPositionY() : mixed
Tags
Return values
mixed —

getRecord()

returns the record of this api

public getRecord() : object
Tags
access

public

Return values
object —

the record as Note-object

getResponsibleID()

public getResponsibleID() : mixed
Tags
Return values
mixed —

getStateID()

public getStateID() : mixed
Tags
Return values
mixed —

getSubContext()

public getSubContext() : mixed
Tags
Return values
mixed —

getType()

public getType() : mixed
Tags
Return values
mixed —

getWidth()

public getWidth() : mixed
Tags
Return values
mixed —

isDeletable()

public isDeletable() : mixed
Tags
Return values
mixed —

isEditable()

public isEditable() : mixed
Tags
Return values
mixed —

isViewable()

public isViewable() : mixed
Tags
Return values
mixed —

setContextModule()

public setContextModule(mixed $contextModule) : mixed
Parameters
$contextModule : mixed
Tags
Return values
mixed —

setContextRecord()

public setContextRecord(mixed $contextRecord) : mixed
Parameters
$contextRecord : mixed
Tags
Return values
mixed —

setContextRecordID()

public setContextRecordID(mixed $contextRecordID) : mixed
Parameters
$contextRecordID : mixed
Tags
Return values
mixed —

setCreationDate()

public setCreationDate(mixed $date) : mixed
Parameters
$date : mixed
Tags
Return values
mixed —

setHeight()

public setHeight(mixed $height) : mixed
Parameters
$height : mixed
Tags
Return values
mixed —

setOwnerID()

public setOwnerID(mixed $ownerID) : mixed
Parameters
$ownerID : mixed
Tags
Return values
mixed —

setPositionX()

public setPositionX(mixed $positionX) : mixed
Parameters
$positionX : mixed
Tags
Return values
mixed —

setPositionY()

public setPositionY(mixed $positionY) : mixed
Parameters
$positionY : mixed
Tags
Return values
mixed —

setResponsibleID()

public setResponsibleID(mixed $responsibleID) : mixed
Parameters
$responsibleID : mixed
Tags
Return values
mixed —

setSubContext()

public setSubContext(mixed $subContext) : mixed
Parameters
$subContext : mixed
Tags
Return values
mixed —

setType()

public setType(mixed $type) : mixed
Parameters
$type : mixed
Tags
Return values
mixed —

setWidth()

public setWidth(mixed $width) : mixed
Parameters
$width : mixed
Tags
Return values
mixed — 

        

        
    




    

    

                

    

        

            
Search results