GetReferringObjects_Result (Type)
Row-limited query returning GetReferringObjects_Result_Row records needed by {object}.getReferringObjects() methods.
Based On:
Rowlimitedquery
Query Row Type:
GetReferringObjects_Result_Row
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| canChangeLinks | Boolean | A boolean flag which when set to true indicates that the current user has sufficient permissions to update links on this page. |
| ChangeAuthor | PlainText | Name of the user who made the change (for WIP items only - blank for 'current' items). |
| DataPageID | NonNegativeInteger | ID of custom element record if the result source type is either custom element or a metadata form. |
| Date | Datetime | The date and time requested by the value within this method's 'displayDate' argument. |
| Description | PlainText_2000 | The page's description or description of the custom field type. |
| EntryID | NonNegativeInteger | ID of corresponding entry in LinkUsage. |
| FileName | Filename | The page's file name or form name where the custom field type is found. |
| IconPath | ServerRelativeURL_EmptyString | A server-relative URL to an icon representing the type of page or document. |
| IconText | PlainText | Text describing the page or document's type. |
| ID | PageID_CustomFieldTypeID | The page's ID of custom field type id. |
| Link | FileName_ValidURL_EmptyString | The page's URL. |
| LinkType | LinkType | An integer representing the link type; for example, 3 (Mail To), 5 (External Image), 10 (Pop-up Menu), and so on. |
| PageType | Integer | An integer representing the page type; for example, 0 (normal or uploaded document), 1 (template), 4 (custom element), 6 (page set), and so on.. or the FormID value for a custom element instance. |
| SourceControlName | PlainText_255 | Name of the control in which the link is found. |
| SourceControlType | PlainText_255 | Type of the source where link is found. |
| SourceControlTypeID | CustomElement_SimpleForm_MetadataForm_ElementType_ID_0 | Type of the control in which the link is found. Basically to get ID of custom element/simple form/metadata form if the link is found in one of those objects. For all other, we can leave 0. |
| SubsiteURL | SubsiteURL_EmptyString | The server-relative URL of the page's subsite or site URL for a custom field type. |
| Title | PlainText_255 | The page's internal CommonSpot title. |
| VersionState | VersionState | Version State (2=current, 3=WIP, etc) of the referring object. |
Error Message:
None