Enables scripted content fragments to use presence
Methods
GetSummary
GetSummary Overload 1
Gets a presence summary for content
Velocity
#set($contentPresenceSummaryResponse = $core_v2_contentPresence.GetSummary($contentUrl, $oauthClientId))
JavaScript
var contentPresenceSummaryResponse = core_v2_contentPresence.GetSummary(contentUrl, oauthClientId);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| contentUrl | String | Content Url | Required | ||
| oauthClientId | Guid | Oauth Client Id | Required |
GetSummary Overload 2
Gets a presence summary for content
Velocity
#set($contentPresenceSummaryResponse = $core_v2_contentPresence.GetSummary($contentUrl, $oauthClientId, "%{ CacheOnly = $cacheOnlyArg, TypeId = $typeIdArg }"))JavaScript
var contentPresenceSummaryResponse = core_v2_contentPresence.GetSummary(contentUrl, oauthClientId, { CacheOnly: cacheOnlyArg, TypeId: typeIdArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| contentUrl | String | Content Url | Required | ||
| oauthClientId | Guid | Oauth Client Id | Required | ||
| CacheOnly | Boolean | When true, only return a result if cached | Optional | ||
| TypeId | Guid | Presence type | Optional |
GetSummary Overload 3
Gets a presence summary for content
Velocity
#set($contentPresenceSummaryResponse = $core_v2_contentPresence.GetSummary($contentId, $contentTypeId))
JavaScript
var contentPresenceSummaryResponse = core_v2_contentPresence.GetSummary(contentId, contentTypeId);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| contentId | Guid | Content Id | Required | ||
| contentTypeId | Guid | Content Type Id | Required |
GetSummary Overload 4
Gets a presence summary for content
Velocity
#set($contentPresenceSummaryResponse = $core_v2_contentPresence.GetSummary($contentId, $contentTypeId, "%{ CacheOnly = $cacheOnlyArg, TypeId = $typeIdArg }"))JavaScript
var contentPresenceSummaryResponse = core_v2_contentPresence.GetSummary(contentId, contentTypeId, { CacheOnly: cacheOnlyArg, TypeId: typeIdArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| contentId | Guid | Content Id | Required | ||
| contentTypeId | Guid | Content Type Id | Required | ||
| CacheOnly | Boolean | When true, only return a result if cached | Optional | ||
| TypeId | Guid | Presence type | Optional |
Returns
RenderAttributes
RenderAttributes Overload 1
Renders HTML attributes to decorate an element with to define it as containing content which the accessing user is automatically made 'present' to when scrolled into view
Velocity
#set($stringResponse = $core_v2_contentPresence.RenderAttributes($contentId, $contentTypeId))
JavaScript
var stringResponse = core_v2_contentPresence.RenderAttributes(contentId, contentTypeId);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| contentId | Guid | Content Id | Required | ||
| contentTypeId | Guid | Content Type Id | Required |
RenderAttributes Overload 2
Renders HTML attributes to decorate an element with to define it as containing content which the accessing user is automatically made 'present' to when scrolled into view
Velocity
#set($stringResponse = $core_v2_contentPresence.RenderAttributes($contentId, $contentTypeId, "%{ CssClass = $cssClassArg, TypeId = $typeIdArg }"))JavaScript
var stringResponse = core_v2_contentPresence.RenderAttributes(contentId, contentTypeId, { CssClass: cssClassArg, TypeId: typeIdArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| contentId | Guid | Content Id | Required | ||
| contentTypeId | Guid | Content Type Id | Required | ||
| CssClass | String | CSS classes to apply | Optional | ||
| TypeId | Guid | Presence type | Optional |
RenderAttributes Overload 3
Renders HTML attributes to decorate an element with to define it as containing content which the accessing user is automatically made 'present' to when scrolled into view
Velocity
#set($stringResponse = $core_v2_contentPresence.RenderAttributes($contentUrl, $oauthClientId))
JavaScript
var stringResponse = core_v2_contentPresence.RenderAttributes(contentUrl, oauthClientId);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| contentUrl | String | Content Url | Required | ||
| oauthClientId | Guid | Oauth Client Id | Required |
RenderAttributes Overload 4
Renders HTML attributes to decorate an element with to define it as containing content which the accessing user is automatically made 'present' to when scrolled into view
Velocity
#set($stringResponse = $core_v2_contentPresence.RenderAttributes($contentUrl, $oauthClientId, "%{ CssClass = $cssClassArg, TypeId = $typeIdArg }"))JavaScript
var stringResponse = core_v2_contentPresence.RenderAttributes(contentUrl, oauthClientId, { CssClass: cssClassArg, TypeId: typeIdArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| contentUrl | String | Content Url | Required | ||
| oauthClientId | Guid | Oauth Client Id | Required | ||
| CssClass | String | CSS classes to apply | Optional | ||
| TypeId | Guid | Presence type | Optional |
Returns
String