ContentPresence In-Process API Service

Ben Tiedt — Fri, 08 Mar 2024 17:31:41 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:31:41

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IContentPresence>() and is defined in Telligent.Evolution.Platform.dll

Events

Events.AfterCreate

Handler

void EventHandler<ContentPresenceAfterCreateEventArgs>(Object sender, ContentPresenceAfterCreateEventArgs e);

Events.AfterDelete

Handler

void EventHandler<ContentPresenceAfterDeleteEventArgs>(Object sender, ContentPresenceAfterDeleteEventArgs e);

Methods

ContentPresence Create(string contentUrl, Guid oauthClientId, ContentPresenceCreateOptions options = null);

Creates a presence mapping for a user to a piece of content

Parameters

Name	Type	Description	Required
contentUrl	`string`	Content url	Required
oauthClientId	`Guid`	OAuthClientId	Required
options	`[[ContentPresenceCreateOptions In-Process API Supplementary Type\|ContentPresenceCreateOptions]]`	Options include: TypeId	Optional

Return Type

[[ContentPresence In-Process API Supplementary Type|ContentPresence]]

ContentPresence Create(Guid contentId, Guid contentTypeId, ContentPresenceCreateOptions options = null);

Creates a presence mapping for a user to a piece of content

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
options	`[[ContentPresenceCreateOptions In-Process API Supplementary Type\|ContentPresenceCreateOptions]]`	Options include: TypeId	Optional

Return Type

[[ContentPresence In-Process API Supplementary Type|ContentPresence]]

AdditionalInfo Delete(Guid contentId, ContentPresenceDeleteOptions options = null);

Removes a presence mapping for a user to a piece of content

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required
options	`[[ContentPresenceDeleteOptions In-Process API Supplementary Type\|ContentPresenceDeleteOptions]]`	Options include: TypeId	Optional

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

AdditionalInfo Delete(string contentUrl, Guid oauthClientId, ContentPresenceDeleteOptions options = null);

Removes a presence mapping for a user to a piece of content

Parameters

Name	Type	Description	Required
contentUrl	`string`	Content url	Required
oauthClientId	`Guid`	OAuthClientId	Required
options	`[[ContentPresenceDeleteOptions In-Process API Supplementary Type\|ContentPresenceDeleteOptions]]`	Options include: TypeId	Optional

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

ContentPresenceSummary GetSummary(Guid contentId, Guid contentTypeId, ContentPresenceSummaryGetOptions options = null);

Gets a presence summary for content

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
options	`[[ContentPresenceSummaryGetOptions In-Process API Supplementary Type\|ContentPresenceSummaryGetOptions]]`	Options include: TypeId	Optional

Return Type

[[ContentPresenceSummary In-Process API Supplementary Type|ContentPresenceSummary]]

ContentPresenceSummary GetSummary(string contentUrl, Guid oauthClientId, ContentPresenceSummaryGetOptions options = null);

Gets a presence summary for content

Parameters

Name	Type	Description	Required
contentUrl	`string`	Content url	Required
oauthClientId	`Guid`	OAuthClientId	Required
options	`[[ContentPresenceSummaryGetOptions In-Process API Supplementary Type\|ContentPresenceSummaryGetOptions]]`	Options include: TypeId	Optional

Return Type

[[ContentPresenceSummary In-Process API Supplementary Type|ContentPresenceSummary]]