RichData implements RestConvertible
Table of Contents
Interfaces
Constants
- CALENDAR_TYPE = 'CALENDAR'
- DYNAMIC_TYPE = 'DYNAMIC'
- LANDING_TYPE = 'LANDING'
- LINK_TYPE = 'LINK'
- POST_TYPE = 'POST'
- TASKS_TYPE = 'TASKS'
Methods
- getAllowedUsers() : array<string|int, mixed>|null
- Returns an array of user ids who can access this rich data If null is returned, then there are no restrictions.
- getDescription() : string|null
- getId() : int|null
- getLink() : string|null
- getName() : string|null
- getPreviewUrl() : string|null
- getRestEntityName() : string
- Returns the name of the entity that will be used in the rest response
- getType() : string|null
- initByAttach() : self
- setAllowedUsers() : RichData
- setDescription() : RichData
- setId() : RichData
- setLink() : RichData
- setName() : RichData
- setPreviewUrl() : RichData
- setType() : RichData
- toRestFormat() : array<string|int, mixed>|null
- Returns an array in JSON like format to return the entity as a rest response.
Constants
CALENDAR_TYPE
public
mixed
CALENDAR_TYPE
= 'CALENDAR'
DYNAMIC_TYPE
public
mixed
DYNAMIC_TYPE
= 'DYNAMIC'
LANDING_TYPE
public
mixed
LANDING_TYPE
= 'LANDING'
LINK_TYPE
public
mixed
LINK_TYPE
= 'LINK'
POST_TYPE
public
mixed
POST_TYPE
= 'POST'
TASKS_TYPE
public
mixed
TASKS_TYPE
= 'TASKS'
Methods
getAllowedUsers()
Returns an array of user ids who can access this rich data If null is returned, then there are no restrictions.
public
getAllowedUsers() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetDescription()
public
getDescription() : string|null
Return values
string|nullgetId()
public
getId() : int|null
Return values
int|nullgetLink()
public
getLink() : string|null
Return values
string|nullgetName()
public
getName() : string|null
Return values
string|nullgetPreviewUrl()
public
getPreviewUrl() : string|null
Return values
string|nullgetRestEntityName()
Returns the name of the entity that will be used in the rest response
public
static getRestEntityName() : string
Return values
stringgetType()
public
getType() : string|null
Return values
string|nullinitByAttach()
public
static initByAttach(CIMMessageParamAttach|null $attach) : self
Parameters
- $attach : CIMMessageParamAttach|null
Return values
selfsetAllowedUsers()
public
setAllowedUsers(array<string|int, mixed> $allowedUsers) : RichData
Parameters
- $allowedUsers : array<string|int, mixed>
Return values
RichDatasetDescription()
public
setDescription(string|null $description) : RichData
Parameters
- $description : string|null
Return values
RichDatasetId()
public
setId(int|null $id) : RichData
Parameters
- $id : int|null
Return values
RichDatasetLink()
public
setLink(string|null $link) : RichData
Parameters
- $link : string|null
Return values
RichDatasetName()
public
setName(string|null $name) : RichData
Parameters
- $name : string|null
Return values
RichDatasetPreviewUrl()
public
setPreviewUrl(string|null $previewUrl) : RichData
Parameters
- $previewUrl : string|null
Return values
RichDatasetType()
public
setType(string|null $type) : RichData
Parameters
- $type : string|null
Return values
RichDatatoRestFormat()
Returns an array in JSON like format to return the entity as a rest response.
public
toRestFormat([array<string|int, mixed> $option = [] ]) : array<string|int, mixed>|null
Parameters
- $option : array<string|int, mixed> = []