Reports.getMultimediaFilesByLinkReference (Method)
Returns zero or more structures, each containing multimedia file information and how many links exist to the file.
Returns:
Reports_GetMultimediaFilesByLinkReference_Result (rowlimitedquery)
Arguments:
Name | Type | Required | Description |
---|---|---|---|
subsiteFilter | SubsiteFilter | Optional. Defaults to '0'. | The ID of the subsite in which CommonSpot searches for objects. If this argument's value is 0, CommonSpot searches all subsites. If this argument's value is -1, CommonSpot searches in the current subsite. |
includeChildSubsites | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true tells CommonSpot that the results should include pages from descendant subsites. |
dateFilterType | DateFilterType_EmptyString | Optional. Defaults to an empty string. | A string describing the date filter that CommonSpot uses when searching for information; for example, 'DateAdded' or 'PublicReleaseDate'. If this argument is an empty string, CommonSpot does not use a date filter type. |
dateFilter | DateFilterValue_EmptyString | Optional. Defaults to an empty string. | Sets the value of the filter that CommonSpot uses when returning results; for example 'This year', 'Last month', 'Last 2 months', and so on. |
orderBy | SQLOrderByClause | Optional. Defaults to 'DateContentLastModified DESC'. | The SQL 'order by' clause indicating which column is used as the returned data's sort key. |
limit | QueryRowLimit | Optional. Defaults to '#this.LIMIT_TO_SCALABILITY_MAX#'. | An integer specifying one more than the maximum number of rows CommonSpot can return. Special values are: 0: Returns all records. -1: Returns the number of records specified in the UI scalability setting. |
displayDate | DisplayDate | Optional. Defaults to 'DateContentLastModified'. | A string describing the date field that CommonSpot displays; for example, 'DateModified', 'PublicReleaseDate', and so on. |
multimediaOwnerFilter | OwnershipFilter | Optional. Defaults to 'Anyone'. | Limits the results based on ownership such as 'Anyone', 'Me', 'MyGroups', 'MeOrMyGroups', 'NotMeOrMyGroups'.. |
typeFilter | PublicPrivateFilter | Optional. Defaults to 'All'. | Limits the results base on the public/private attribute of the item. For example 'All', 'Public' or 'Private'. |
channelFilter | MultimediaChannelID_0 | Optional. Defaults to '0'. | ID of the channel. |
multimediaServiceFilter | MultimediaServiceID_0 | Optional. Defaults to '0'. | ID of the service. |
contentType | MultimediaContentType | Optional. Defaults to 'Multimedia File'. | Type of multimedia content to look for. Ex; 'Multimedia File', 'Multimedia Playlist'. |
Context:
License Requirements | (none) |
Permission Requirements | ContributorOrServerCode |
Deny Context | (none) |
Require Context | (none) |
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