Enables scripted content fragments to use presence
Methods
GetSummary
Gets a presence summary for content
Usage
#set($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 |
Return Type
GetSummary
Gets a presence summary for content
Usage
#set($contentPresenceSummaryResponse = $core_v2_contentPresence.GetSummary($contentUrl, $oauthClientId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required | ||
TypeId | Guid | Presence type | Optional |
Return Type
GetSummary
Gets a presence summary for content
Usage
#set($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 |
Return Type
GetSummary
Gets a presence summary for content
Usage
#set($contentPresenceSummaryResponse = $core_v2_contentPresence.GetSummary($contentId, $contentTypeId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required | ||
TypeId | Guid | Presence type | Optional |
Return Type
RenderAttributes
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
Usage
#set($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 |
Return Type
string
RenderAttributes
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
Usage
#set($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 |
Return Type
string
RenderAttributes
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
Usage
#set($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 |
Return Type
string
RenderAttributes
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
Usage
#set($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 |
Return Type
string