Enables scripted content fragments to use Features
Methods
CanFeature
Identifies if the accessing user can feature the specified content
Usage
#set($booleanResponse = $core_v3_feature.CanFeature($contentId, $contentTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required |
Return Type
bool
CanFeature
Identifies if the accessing user can feature the specified external content
Usage
#set($booleanResponse = $core_v3_feature.CanFeature($contentUrl, $oauthClientId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required |
Return Type
bool
Create
Usage
#set($featureResponse = $core_v3_feature.Create($contentId, $contentTypeId, "%{EndDate = $endDateArg, FeatureTargets = $featureTargetsArg, FileData = $fileDataArg, FileName = $fileNameArg, FileUploadContext = $fileUploadContextArg, StartDate = $startDateArg, TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required | ||
EndDate | DateTime | End Date | Optional | ||
FeatureTargets | string | Feature Targets | Optional | ||
FileData | string | File Data. When adding an image either FileData or FileUploadContext is required. | Optional | ||
FileName | string | File Name. Required when updating featured item using FileUploadContext. Optional parameter | Optional | ||
FileUploadContext | string | File Upload Context. When adding an image either FileData or FileUploadContext is required. Optional parameter | Optional | ||
StartDate | DateTime | Start Date | Optional | ||
TypeId | int | Type Id | Optional |
Return Type
Create
Usage
#set($featureResponse = $core_v3_feature.Create($contentUrl, $oauthClientId, "%{EndDate = $endDateArg, FeatureTargets = $featureTargetsArg, FileData = $fileDataArg, FileName = $fileNameArg, FileUploadContext = $fileUploadContextArg, StartDate = $startDateArg, TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required | ||
EndDate | DateTime | End Date | Optional | ||
FeatureTargets | string | Feature Targets | Optional | ||
FileData | string | File Data. When adding an image either FileData or FileUploadContext is required. | Optional | ||
FileName | string | File Name. Required when updating featured item using FileUploadContext. Optional parameter | Optional | ||
FileUploadContext | string | File Upload Context. When adding an image either FileData or FileUploadContext is required. Optional parameter | Optional | ||
StartDate | DateTime | Start Date | Optional | ||
TypeId | int | Type Id | Optional |
Return Type
Delete
Usage
#set($additionalInfoResponse = $core_v3_feature.Delete($contentId, $contentTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required |
Return Type
Delete
Usage
#set($additionalInfoResponse = $core_v3_feature.Delete($contentUrl, $oauthClientId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required | ||
TypeId | int | Type Id | Optional |
Return Type
Get
Usage
#set($featureResponse = $core_v3_feature.Get($contentId, $contentTypeId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required | ||
TypeId | int | Type Id | Optional |
Return Type
Get
Usage
#set($featureResponse = $core_v3_feature.Get($contentUrl, $oauthClientId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required | ||
TypeId | int | Type Id | Optional |
Return Type
List
Usage
#set($pagedListResponse = $core_v3_feature.List("%{ApplicationId = $applicationIdArg, ContainerId = $containerIdArg, ContentId = $contentIdArg, ContentTypeIds = $contentTypeIdsArg, ContentUrl = $contentUrlArg, IncludeFutureDatedItems = $includeFutureDatedItemsArg, IncludeSubContainers = $includeSubContainersArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, TargetContainerId = $targetContainerIdArg, TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ApplicationId | Guid | Filter by content's application | Optional | ||
ContainerId | Guid | Filter by content's group | Optional | ||
ContentId | Guid | Content Id | Optional | ||
ContentTypeIds | string | Comma delimited list of Content Type Ids to return | Optional | ||
ContentUrl | string | Content Url | Optional | ||
IncludeFutureDatedItems | bool | Include Future Dated Items | Optional | ||
IncludeSubContainers | bool | Include sub container's of provided containerId | Optional | False | |
PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | int | Specify the number of results to return per page. | Optional | 5 | |
SortBy | string | Sort By | Optional | FeatureDate | EndDate, FeatureDate, StartDate |
SortOrder | string | Sort Order | Optional | Ascending | Ascending, Descending |
TargetContainerId | Guid | Filter by container Feature will be displayed in | Optional | ||
TypeId | Guid | Type Id | Optional |
Return Type
SupportsFeatures
Identifies if featuring is supported by the specified content type
Usage
#set($booleanResponse = $core_v3_feature.SupportsFeatures($contentTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentTypeId | Guid | Content Type Id | Required |
Return Type
bool
Update
Usage
#set($featureResponse = $core_v3_feature.Update($contentId, $contentTypeId, "%{EndDate = $endDateArg, FeatureTargets = $featureTargetsArg, FileData = $fileDataArg, FileName = $fileNameArg, FileUploadContext = $fileUploadContextArg, RemoveFeatureImage = $removeFeatureImageArg, StartDate = $startDateArg, TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required | ||
EndDate | DateTime | End Date | Optional | ||
FeatureTargets | string | Feature Targets | Optional | ||
FileData | string | File Data. When adding an image either FileData or FileUploadContext is required. | Optional | ||
FileName | string | File Name. Required when updating featured item using FileUploadContext. Optional parameter | Optional | ||
FileUploadContext | string | File Upload Context. When adding an image either FileData or FileUploadContext is required. Optional parameter | Optional | ||
RemoveFeatureImage | bool | If, true existing featured image will be removed. | Optional | ||
StartDate | DateTime | Start Date | Optional | ||
TypeId | int | Type Id | Optional |
Return Type
Update
Usage
#set($featureResponse = $core_v3_feature.Update($contentUrl, $oauthClientId, "%{EndDate = $endDateArg, FeatureTargets = $featureTargetsArg, FileData = $fileDataArg, FileName = $fileNameArg, FileUploadContext = $fileUploadContextArg, StartDate = $startDateArg, TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required | ||
EndDate | DateTime | End Date | Optional | ||
FeatureTargets | string | Feature Targets | Optional | ||
FileData | string | File Data. When adding an image either FileData or FileUploadContext is required. | Optional | ||
FileName | string | File Name. Required when updating featured item using FileUploadContext. Optional parameter | Optional | ||
FileUploadContext | string | File Upload Context. When adding an image either FileData or FileUploadContext is required. Optional parameter | Optional | ||
StartDate | DateTime | Start Date | Optional | ||
TypeId | int | Type Id | Optional |