Apex Reference Guide
jNewer Version Available
ManagedContentDelivery Class
Get collection items. Get a managed
content channel. Get managed content.
Namespace
ManagedContentDelivery Methods
The following are methods for ManagedContentDelivery. All methods are static.
getCollectionItemsForChannel(channelId, collectionKeyOrId, language)
Get collection items for a channel.
API Version
56.0
Available to Guest Users
56.0
Requires Chatter
No
Signature
public static ConnectApi.ManagedContentCollectionItems getCollectionItemsForChannel(String channelId, String collectionKeyOrId, String language)
Parameters
- channelId
- Type: String
- ID of the channel.
- collectionKeyOrId
- Type: String
- Collection key or ID of the collection. A collection key is a unique identifier such as MCA4CCV5QS2BAB5H7YRCRPTCWGZQ.
- language
- Type: String
- Language locale for the managed content, for example, en_US. If the requested translation isn’t available, the language defaults to the channel or site’s default language. If the channel or site’s default language isn’t available, the language defaults to the primary language of the content space.
Return Value
getCollectionItemsForSite(siteId, collectionKeyOrId, language)
Get collection items for an Experience Cloud site.
API Version
56.0
Available to Guest Users
56.0
Requires Chatter
No
Signature
public static ConnectApi.ManagedContentCollectionItems getCollectionItemsForSite(String siteId, String collectionKeyOrId, String language)
Parameters
- siteId
- Type: String
- ID for the Experience Cloud site.
- collectionKeyOrId
- Type: String
- Collection key or ID of the collection. A collection key is a unique identifier such as MCA4CCV5QS2BAB5H7YRCRPTCWGZQ.
- language
- Type: String
- Language locale for the managed content, for example, en_US. If the requested translation isn’t available, the language defaults to the channel or site’s default language. If the channel or site’s default language isn’t available, the language defaults to the primary language of the content space.
Return Value
getManagedContentChannel(channelId)
Get a managed content channel.
API Version
54.0
Available to Guest Users
54.0
Requires Chatter
No
Signature
public static ConnectApi.ManagedContentChannelDetail getManagedContentChannel(String channelId)
Parameters
- channelId
- Type: String
- ID of the channel.
Return Value
getManagedContentForChannel(channelId, contentKeyOrId, showAbsoluteUrl)
Get a piece of published content for a channel.
API Version
54.0
Available to Guest Users
54.0
Requires Chatter
No
Signature
public static ConnectApi.ManagedContentDeliveryDocument getManagedContentForChannel(String channelId, String contentKeyOrId, Boolean showAbsoluteUrl)
Parameters
- channelId
- Type: String
- ID of the channel.
- contentKeyOrId
- Type: String
- Content key or ID of the content. A content key is a unique identifier such as MCA4CCV5QS2BAB5H7YRCRPTCWGZQ.
- showAbsoluteUrl
- Type: Boolean
- For public channels only, specifies whether to return the absolute unauthenticatedUrl in the output class. The default value is false.
Return Value
Usage
This method returns content only if it's published in the default language of the channel. If you request content that isn’t published in the default language of the channel, you get a ConnectApi.NotFoundException. To get content for a channel in another language use getManagedContentForChannel(channelId, contentKeyOrId, language, showAbsoluteUrl) or getManagedContentForChannel(channelId, contentKeyOrId, language, showAbsoluteUrl, referenceDepth, expandReferences, referencesAsList).
getManagedContentForChannel(channelId, contentKeyOrId, language, showAbsoluteUrl)
Get a piece of published content in a specified language for a channel.
API Version
54.0
Available to Guest Users
54.0
Requires Chatter
No
Signature
public static ConnectApi.ManagedContentDeliveryDocument getManagedContentForChannel(String channelId, String contentKeyOrId, String language, Boolean showAbsoluteUrl)
Parameters
- channelId
- Type: String
- ID of the channel.
- contentKeyOrId
- Type: String
- Content key or ID of the content. A content key is a unique identifier such as MCA4CCV5QS2BAB5H7YRCRPTCWGZQ.
- language
- Type: String
- Language locale for the managed content, for example, en_US. The requested language must be added to the channel, otherwise, you get a ConnectApi.NotFoundException. If the requested translation isn’t available, the language defaults to the channel or site’s default language. If the channel or site’s default language isn’t available, the language defaults to the primary language of the content space.
- showAbsoluteUrl
- Type: Boolean
- For public channels only, specifies whether to return the absolute unauthenticatedUrl in the output class. The default value is false.
Return Value
getManagedContentForChannel(channelId, contentKeyOrId, language, showAbsoluteUrl, referenceDepth, expandReferences, referencesAsList)
Get a piece of published content in a specified language with references for a
channel.
API Version
54.0
Available to Guest Users
54.0
Requires Chatter
No
Signature
public static ConnectApi.ManagedContentDeliveryDocument getManagedContentForChannel(String channelId, String contentKeyOrId, String language, Boolean showAbsoluteUrl, Integer referenceDepth, Boolean expandReferences, Boolean referencesAsList)
Parameters
- channelId
- Type: String
- ID of the channel.
- contentKeyOrId
- Type: String
- Content key or ID of the content. A content key is a unique identifier such as MCA4CCV5QS2BAB5H7YRCRPTCWGZQ.
- language
- Type: String
- Language locale for the managed content, for example, en_US. The requested language must be added to the channel, otherwise, you get a ConnectApi.NotFoundException. If the requested translation isn’t available, the language defaults to the channel or site’s default language. If the channel or site’s default language isn’t available, the language defaults to the primary language of the content space.
- showAbsoluteUrl
- Type: Boolean
- For public channels only, specifies whether to return the absolute unauthenticatedUrl in the output class. The default value is false.
- referenceDepth
- Type: Integer
- An integer 0–3 specifying the depth of references. If you specify 0, the references property of the ConnectApi.ManagedContentDeliveryDocument output class is null. If unspecified, the default value is 0.
- expandReferences
- Type: Boolean
- Specifies whether to include details of references (true) or summaries of references (false) in the output class. If unspecified, the default value is false.
- referencesAsList
- Type: Boolean
- Specifies whether to return the references as a list in the referencesList property of the ConnectApi.ManagedContentDeliveryDocument output class (true). If you specify false, the references are returned as key value pairs in the references property. If unspecified, the default value is false.
Return Value
getManagedContentForSite(siteId, contentKeyOrId, showAbsoluteUrl)
Get a piece of published content for an Experience Cloud site.
API Version
54.0
Available to Guest Users
54.0
Requires Chatter
No
Signature
public static ConnectApi.ManagedContentDeliveryDocument getManagedContentForSite(String siteId, String contentKeyOrId, Boolean showAbsoluteUrl)
Parameters
- siteId
- Type: String
- ID for the Experience Cloud site.
- contentKeyOrId
- Type: String
- Content key or ID of the content. A content key is a unique identifier such as MCA4CCV5QS2BAB5H7YRCRPTCWGZQ.
- showAbsoluteUrl
- Type: Boolean
- For public channels only, specifies whether to return the absolute unauthenticatedUrl in the output class. The default value is false.
Return Value
getManagedContentForSite(siteId, contentKeyOrId, language, showAbsoluteUrl)
Get a piece of published content in a specified language for an Experience Cloud
site.
API Version
54.0
Available to Guest Users
54.0
Requires Chatter
No
Signature
public static ConnectApi.ManagedContentDeliveryDocument getManagedContentForSite(String siteId, String contentKeyOrId, String language, Boolean showAbsoluteUrl)
Parameters
- siteId
- Type: String
- ID for the Experience Cloud site.
- contentKeyOrId
- Type: String
- Content key or ID of the content. A content key is a unique identifier such as MCA4CCV5QS2BAB5H7YRCRPTCWGZQ.
- language
- Type: String
- Language locale for the managed content, for example, en_US. If the requested translation isn’t available, the language defaults to the channel or site’s default language. If the channel or site’s default language isn’t available, the language defaults to the primary language of the content space.
- showAbsoluteUrl
- Type: Boolean
- For public channels only, specifies whether to return the absolute unauthenticatedUrl in the output class. The default value is false.
Return Value
getManagedContentForSite(siteId, contentKeyOrId, language, showAbsoluteUrl, referenceDepth, expandReferences, referencesAsList)
Get a piece of published content in a specified language with references for an
Experience Cloud site.
API Version
54.0
Available to Guest Users
54.0
Requires Chatter
No
Signature
public static ConnectApi.ManagedContentDeliveryDocument getManagedContentForSite(String siteId, String contentKeyOrId, String language, Boolean showAbsoluteUrl, Integer referenceDepth, Boolean expandReferences, Boolean referencesAsList)
Parameters
- siteId
- Type: String
- ID for the Experience Cloud site.
- contentKeyOrId
- Type: String
- Content key or ID of the content. A content key is a unique identifier such as MCA4CCV5QS2BAB5H7YRCRPTCWGZQ.
- language
- Type: String
- Language locale for the managed content, for example, en_US. If the requested translation isn’t available, the language defaults to the channel or site’s default language. If the channel or site’s default language isn’t available, the language defaults to the primary language of the content space.
- showAbsoluteUrl
- Type: Boolean
- For public channels only, specifies whether to return the absolute unauthenticatedUrl in the output class. The default value is false.
- referenceDepth
- Type: Integer
- An integer 0–3 specifying the depth of references. If you specify 0, the references property of the ConnectApi.ManagedContentDeliveryDocument output class is null. If unspecified, the default value is 0.
- expandReferences
- Type: Boolean
- Specifies whether to include details of references (true) or summaries of references (false) in the output class. If unspecified, the default value is false.
- referencesAsList
- Type: Boolean
- Specifies whether to return the references as a list in the referencesList property of the ConnectApi.ManagedContentDeliveryDocument output class (true). If you specify false, the references are returned as key value pairs in the references property. If unspecified, the default value is false.
Return Value
getManagedContentsForChannel(channelId, managedContentIds, contentKeys, contentTypeFQN, language, publishStartDate, publishEndDate, includeContentBody, referenceDepth, expandReferences, referencesAsList, pageParam, pageSize)
Get a collection of published contents for a channel.
API Version
Available to Guest Users
55.0—57.0
Requires Chatter
No
Signature
public static ConnectApi.ManagedContentDeliveryDocumentCollection getManagedContentsForChannel(String channelId, List<String> managedContentIds, List<String> contentKeys, String contentTypeFQN, String language, String publishStartDate, String publishEndDate, Boolean includeContentBody, Integer referenceDepth, Boolean expandReferences, Boolean referencesAsList, Integer pageParam, Integer pageSize)
Parameters
- channelId
- Type: String
- ID of the channel.
- managedContentIds
- Type: List<String>
- Comma-separated list of up to 100 managed content IDs. Specify either managed content IDs or content keys.
- contentKeys
- Type: List<String>
- Comma-separated list of up to 50 content keys. Specify either managed content IDs or content keys.
- contentTypeFQN
- Type: String
- Fully qualified name of the managed content type.
- language
- Type: String
- Language locale for the managed content, for example, en_US. If the requested translation isn’t available, the language defaults to the configured fallback language or the channel’s default language. If the content isn’t available in the fallback language and the channel’s default language, we return an error.
- publishStartDate
- Type: String
- ISO 8601 formatted publish start date.
- publishEndDate
- Type: String
- ISO 8601 formatted publish end date.
- includeContentBody
- Type: Boolean
- Specifies whether to return the content body (true) or the content summary (false). If unspecified, the default value is false.
- referenceDepth
- Type: Integer
- An integer 0–3 specifying the depth of references. If you specify 0, the references property of the ConnectApi.ManagedContentDeliveryDocumentCollection output class is null. If unspecified, the default value is 0.
- expandReferences
- Type: Boolean
- Specifies whether to include details of references (true) or summaries of references (false) in the output class. If unspecified, the default value is false.
- referencesAsList
- Type: Boolean
- Specifies whether to return the references as a list in the referencesList property of the ConnectApi.ManagedContentDeliveryDocumentCollection output class (true). If you specify false, the references are returned as key value pairs in the references property. If unspecified, the default value is false.
- pageParam
- Type: Integer
- Number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
- pageSize
- Type: Integer
- Specifies the number of items per page. Valid values are from 1 through 250. If you pass in null, the default size is 25. If you specify true for expandReferences or includeContentBody, the maximum page size you can specify is 25.
Return Value
getManagedContentsForChannel(channelId, managedContentIds, contentKeys, contentTypeFQN, language, publishStartDate, publishEndDate, includeContentBody, referenceDepth, expandReferences, referencesAsList, pageParam, pageSize, showAbsoluteUrl)
Get a collection of published contents for a channel.
API Version
58.0
Available to Guest Users
58.0
Requires Chatter
No
Signature
public static ConnectApi.ManagedContentDeliveryDocumentCollection getManagedContentsForChannel(String channelId, List<String> managedContentIds, List<String> contentKeys, String contentTypeFQN, String language, String publishStartDate, String publishEndDate, Boolean includeContentBody, Integer referenceDepth, Boolean expandReferences, Boolean referencesAsList, Integer pageParam, Integer pageSize, Boolean showAbsoluteUrl)
Parameters
- channelId
- Type: String
- ID of the channel.
- managedContentIds
- Type: List<String>
- Comma-separated list of up to 100 managed content IDs. Specify either managed content IDs or content keys.
- contentKeys
- Type: List<String>
- Comma-separated list of up to 50 content keys. Specify either managed content IDs or content keys.
- contentTypeFQN
- Type: String
- Fully qualified name of the managed content type.
- language
- Type: String
- Language locale for the managed content, for example, en_US. If the requested translation isn’t available, the language defaults to the configured fallback language or the channel’s default language. If the content isn’t available in the fallback language and the channel’s default language, we return an error.
- publishStartDate
- Type: String
- ISO 8601 formatted publish start date.
- publishEndDate
- Type: String
- ISO 8601 formatted publish end date.
- includeContentBody
- Type: Boolean
- Specifies whether to return the content body (true) or the content summary (false). If unspecified, the default value is false.
- referenceDepth
- Type: Integer
- An integer 0–3 specifying the depth of references. If you specify 0, the references property of the ConnectApi.ManagedContentDeliveryDocumentCollection output class is null. If unspecified, the default value is 0.
- expandReferences
- Type: Boolean
- Specifies whether to include details of references (true) or summaries of references (false) in the output class. If unspecified, the default value is false.
- referencesAsList
- Type: Boolean
- Specifies whether to return the references as a list in the referencesList property of the ConnectApi.ManagedContentDeliveryDocumentCollection output class (true). If you specify false, the references are returned as key value pairs in the references property. If unspecified, the default value is false.
- pageParam
- Type: Integer
- Number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
- pageSize
- Type: Integer
- Specifies the number of items per page. Valid values are from 1 through 250. If you pass in null, the default size is 25. If you specify true for expandReferences or includeContentBody, the maximum page size you can specify is 25.
- showAbsoluteUrl
- Type: Boolean
- Specifies whether to show absolute URLs in the output class (true) or not (false). The default value is false.
Return Value
getManagedContentsForSite(siteId, managedContentIds, contentKeys, contentTypeFQN, language, publishStartDate, publishEndDate, includeContentBody, referenceDepth, expandReferences, referencesAsList, pageParam, pageSize)
Get a collection of published contents for an Experience Cloud site.
API Version
Available to Guest Users
55.0—57.0
Requires Chatter
No
Signature
public static ConnectApi.ManagedContentDeliveryDocumentCollection getManagedContentsForSite(String siteId, List<String> managedContentIds, List<String> contentKeys, String contentTypeFQN, String language, String publishStartDate, String publishEndDate, Boolean includeContentBody, Integer referenceDepth, Boolean expandReferences, Boolean referencesAsList, Integer pageParam, Integer pageSize)
Parameters
- siteId
- Type: String
- ID for the Experience Cloud site.
- managedContentIds
- Type: List<String>
- Comma-separated list of up to 100 managed content IDs. Specify either managed content IDs or content keys.
- contentKeys
- Type: List<String>
- Comma-separated list of up to 50 content keys. Specify either managed content IDs or content keys.
- contentTypeFQN
- Type: String
- Fully qualified name of the managed content type.
- language
- Type: String
- Language locale for the managed content, for example, en_US. If the requested translation isn’t available, the language defaults to the configured fallback language or the channel’s default language. If the content isn’t available in the fallback language and the channel’s default language, we return an error.
- publishStartDate
- Type: String
- ISO 8601 formatted publish start date.
- publishEndDate
- Type: String
- ISO 8601 formatted publish end date.
- includeContentBody
- Type: Boolean
- Specifies whether to return the content body (true) or the content summary (false). If unspecified, the default value is false.
- referenceDepth
- Type: Integer
- An integer 0–3 specifying the depth of references. If you specify 0, the references property of the ConnectApi.ManagedContentDeliveryDocumentCollection output class is null. If unspecified, the default value is 0.
- expandReferences
- Type: Boolean
- Specifies whether to include details of references (true) or summaries of references (false) in the output class. If unspecified, the default value is false.
- referencesAsList
- Type: Boolean
- Specifies whether to return the references as a list in the referencesList property of the ConnectApi.ManagedContentDeliveryDocumentCollection output class (true). If you specify false, the references are returned as key value pairs in the references property. If unspecified, the default value is false.
- pageParam
- Type: Integer
- Number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
- pageSize
- Type: Integer
- Specifies the number of items per page. Valid values are from 1 through 250. If you pass in null, the default size is 25. If you specify true for expandReferences or includeContentBody, the maximum page size you can specify is 25.
Return Value
getManagedContentsForSite(siteId, managedContentIds, contentKeys, contentTypeFQN, language, publishStartDate, publishEndDate, includeContentBody, referenceDepth, expandReferences, referencesAsList, pageParam, pageSize, showAbsoluteUrl)
Get a collection of published contents for an Experience Cloud site.
API Version
58.0
Available to Guest Users
58.0
Requires Chatter
No
Signature
public static ConnectApi.ManagedContentDeliveryDocumentCollection getManagedContentsForSite(String siteId, List<String> managedContentIds, List<String> contentKeys, String contentTypeFQN, String language, String publishStartDate, String publishEndDate, Boolean includeContentBody, Integer referenceDepth, Boolean expandReferences, Boolean referencesAsList, Integer pageParam, Integer pageSize, Boolean showAbsoluteUrl)
Parameters
- siteId
- Type: String
- ID for the Experience Cloud site.
- managedContentIds
- Type: List<String>
- Comma-separated list of up to 100 managed content IDs. Specify either managed content IDs or content keys.
- contentKeys
- Type: List<String>
- Comma-separated list of up to 50 content keys. Specify either managed content IDs or content keys.
- contentTypeFQN
- Type: String
- Fully qualified name of the managed content type.
- language
- Type: String
- Language locale for the managed content, for example, en_US. If the requested translation isn’t available, the language defaults to the configured fallback language or the channel’s default language. If the content isn’t available in the fallback language and the channel’s default language, we return an error.
- publishStartDate
- Type: String
- ISO 8601 formatted publish start date.
- publishEndDate
- Type: String
- ISO 8601 formatted publish end date.
- includeContentBody
- Type: Boolean
- Specifies whether to return the content body (true) or the content summary (false). If unspecified, the default value is false.
- referenceDepth
- Type: Integer
- An integer 0–3 specifying the depth of references. If you specify 0, the references property of the ConnectApi.ManagedContentDeliveryDocumentCollection output class is null. If unspecified, the default value is 0.
- expandReferences
- Type: Boolean
- Specifies whether to include details of references (true) or summaries of references (false) in the output class. If unspecified, the default value is false.
- referencesAsList
- Type: Boolean
- Specifies whether to return the references as a list in the referencesList property of the ConnectApi.ManagedContentDeliveryDocumentCollection output class (true). If you specify false, the references are returned as key value pairs in the references property. If unspecified, the default value is false.
- pageParam
- Type: Integer
- Number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
- pageSize
- Type: Integer
- Specifies the number of items per page. Valid values are from 1 through 250. If you pass in null, the default size is 25. If you specify true for expandReferences or includeContentBody, the maximum page size you can specify is 25.
- showAbsoluteUrl
- Type: Boolean
- Specifies whether to show absolute URLs in the output class (true) or not (false). The default value is false.