Enables scripted content fragments to use service presence
Methods
GetSummary
Gets a presence summary for a service
Usage
#set($servicePresenceSummaryResponse = $core_v2_servicePresence.GetSummary($serviceId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
serviceId | Guid | Service Id | Required |
Return Type
GetSummary
Gets a presence summary for a service
Usage
#set($servicePresenceSummaryResponse = $core_v2_servicePresence.GetSummary($serviceId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
serviceId | Guid | Service Id | Required | ||
TypeId | Guid | Presence type | Optional |
Return Type
RenderAttributes
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
Usage
#set($stringResponse = $core_v2_servicePresence.RenderAttributes($serviceId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
serviceId | Guid | Service Id | Required |
Return Type
string
RenderAttributes
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
Usage
#set($stringResponse = $core_v2_servicePresence.RenderAttributes($serviceId, "%{CssClass = $cssClassArg, TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
serviceId | Guid | Service Id | Required | ||
CssClass | string | CSS classes to apply | Optional | ||
TypeId | Guid | Presence type | Optional |
Return Type
string