Multimedia.getReferringObjects (Method)
Returns zero or more structures, each containing information on elements that refer to this multimedia file. This method's arguments limit the amount of information CommonSpot returns.
Returns:
GetReferringObjects_Result (rowlimitedquery)
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| multimediaID | MultimediaID | Required | A multimedia file's ID. |
| limit | QueryRowLimit | Optional. Defaults to '#this.LIMIT_TO_SCALABILITY_MAX#'. | An integer specifying one more than the maximum number of rows CommonSpot can return. If this value is 0, it returns all records. If it is -1, CommonSpot can return the number of records specified in the UI scalability setting. |
| subsiteFilter | SubsiteFilter | Optional. Defaults to '0'. | The subsite's ID. If this value is -1, CommonSpot returns information on the current subsite. If this is 0, CommonSpot returns information for all subsites. |
| includeChildSubsites | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true indicates that the search includes child subsites. |
| dateFilterType | DateFilterTypeNonPage_EmptyString | Optional. Defaults to an empty string. | A date filter type that CommonSpot uses when searching for information; for example, 'DateFilter', 'DateContentLastModified', or an empty string. |
| dateFilter | DateFilterValue_EmptyString | Optional. Defaults to an empty string. | A date filter value or an empty string; for example, 'Last 2 months'. An empty string tells CommonSpot that it should not use a date filter value. |
| displayDate | DisplayDate | Optional. Defaults to 'DateContentLastModified'. | A string describing the date field to display; for example, 'DateAdded', 'PublicReleaseDate', and so on. An empty string tells CommonSpot that it should not use a date filter value. |
| orderBy | SQLOrderByClause | Optional. Defaults to 'Title ASC'. | The SQL 'order by' clause, which indicates the order in which results are returned. |
Context:
| License Requirements | (none) |
| Permission Requirements | ContributorOrServerCode |
| Deny Context | (none) |
| Require Context | Authoring |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | Customization is not supported for this method. |
Error Codes:
None
Notes:
None