Enables scripted content fragments to use service presence
Methods
GetSummary
GetSummary Overload 1
Gets a presence summary for a service
Velocity
#set($servicePresenceSummaryResponse = $core_v2_servicePresence.GetSummary($serviceId))
JavaScript
var servicePresenceSummaryResponse = core_v2_servicePresence.GetSummary(serviceId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
serviceId | Guid | Service Id | Required |
GetSummary Overload 2
Gets a presence summary for a service
Velocity
#set($servicePresenceSummaryResponse = $core_v2_servicePresence.GetSummary($serviceId, "%{ TypeId = $typeIdArg }"))
JavaScript
var servicePresenceSummaryResponse = core_v2_servicePresence.GetSummary(serviceId, { TypeId: typeIdArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
serviceId | Guid | Service Id | Required | ||
options | Options | Set of optional parameters including: | Required | ||
TypeId | Guid | Presence type | Optional |
Returns
RenderAttributes
RenderAttributes Overload 1
Renders HTML attributes to decorate an element with to define it as containing service which the accessing user is automatically made 'present' to when scrolled into view
Velocity
#set($stringResponse = $core_v2_servicePresence.RenderAttributes($serviceId))
JavaScript
var stringResponse = core_v2_servicePresence.RenderAttributes(serviceId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
serviceId | Guid | Service Id | Required |
RenderAttributes Overload 2
Renders HTML attributes to decorate an element with to define it as containing service which the accessing user is automatically made 'present' to when scrolled into view
Velocity
#set($stringResponse = $core_v2_servicePresence.RenderAttributes($serviceId, "%{ CssClass = $cssClassArg, TypeId = $typeIdArg }"))
JavaScript
var stringResponse = core_v2_servicePresence.RenderAttributes(serviceId, { CssClass: cssClassArg, TypeId: typeIdArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
serviceId | Guid | Service Id | Required | ||
options | Options | Set of optional parameters including: | Required | ||
CssClass | String | CSS classes to apply | Optional | ||
TypeId | Guid | Presence type | Optional |
Returns
String