Tags In-Process API Service

Work with tags

This service is available via Telligent.Evolution.Extensibility.Api.Version1.PublicApi.Tags or Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.ITags>() and is defined in Telligent.Evolution.Api.dll

Events

Events.AfterAdd

Handler

void TagAfterAddEventHandler(TagAfterAddEventArgs e);

Events.AfterRemove

Handler

void TagAfterRemoveEventHandler(TagAfterRemoveEventArgs e);

Events.BeforeAdd

Handler

void TagBeforeAddEventHandler(TagBeforeAddEventArgs e);

Events.BeforeRemove

Handler

void TagBeforeRemoveEventHandler(TagBeforeRemoveEventArgs e);

Methods

AdditionalInfo Add(string tag, TagAddOptions options);

Creates a seed tag.

Parameters

Name	Type	Description	Required	Default	Options
tag	`string`	Tag	Required
options	`TagAddOptions`	Tag add options	Required

Return Type

AdditionalInfo

AdditionalInfo Add(Guid contentId, Guid contentTypeId, Guid? typeId, string tags);

Add a tag or tags to a piece of content.

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content type Id	Required
typeId	`Guid?`	Categorization type	Required
tags	`string`	Comma-separated list of tags	Required

Return Type

AdditionalInfo

AdditionalInfo Add(string contentUrl, Guid oauthClientId, Guid? typeId, string tags);

Add a tag or tags to a piece of content.

Parameters

Name	Type	Description	Required
contentUrl	`string`	Content Url	Required
oauthClientId	`Guid`	Oauth client Id	Required
typeId	`Guid?`	Categorization type	Required
tags	`string`	Comma-separated list of tags	Required

Return Type

AdditionalInfo

bool CanAddTags(Guid contentId, Guid contentTypeId);

Checks whether the accessing user can add tags to this content type.

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content type Id	Required

Return Type

bool

bool CanAddTags(string contentUrl, Guid oauthClientId);

Checks whether the accessing user can add tags to this content type.

Parameters

Name	Type	Description	Required	Default	Options
contentUrl	`string`	Content Url	Required
oauthClientId	`Guid`	Oauth client Id	Required

Return Type

bool

bool CanAddTagsInApplication(Guid applicationId, Guid applicationTypeId);

Checks whether the accessing user can add seed tags for a specific application

Parameters

Name	Type	Description	Required	Default	Options
applicationId	`Guid`	ApplicationId	Required
applicationTypeId	`Guid`	Application type Id	Required

Return Type

bool

bool CanAddTagsInApplicationType(Guid applicationTypeId);

Checks whether the accessing user can add seed tags for a specific application

Parameters

Name	Type	Description	Required	Default	Options
applicationTypeId	`Guid`	Application type Id	Required

Return Type

bool

bool CanDeleteTagsInApplication(Guid applicationId, Guid applicationTypeId);

Checks whether the accessing user can remove tags in bulk for a specific application

Parameters

Name	Type	Description	Required	Default	Options
applicationId	`Guid`	ApplicationId	Required
applicationTypeId	`Guid`	Application type Id	Required

Return Type

bool

bool CanDeleteTagsInApplicationType(Guid applicationTypeId);

Checks whether the accessing user can remove tags in bulk for a specific application type

Parameters

Name	Type	Description	Required	Default	Options
applicationTypeId	`Guid`	Application type Id	Required

Return Type

bool

bool CanRemoveTags(string contentUrl, Guid oauthClientId);

Checks whether the accessing user can remove tags from this content type.

Parameters

Name	Type	Description	Required	Default	Options
contentUrl	`string`	Content Url	Required
oauthClientId	`Guid`	Oauth client Id	Required

Return Type

bool

bool CanRemoveTags(Guid contentId, Guid contentTypeId);

Checks whether the accessing user can remove tags from this content type.

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content type Id	Required

Return Type

bool

bool CanRenameTagsInApplication(Guid applicationId, Guid applicationTypeId);

Checks whether the accessing user can rename tags in bulk for a specific application

Parameters

Name	Type	Description	Required	Default	Options
applicationId	`Guid`	ApplicationId	Required
applicationTypeId	`Guid`	Application type Id	Required

Return Type

bool

bool CanRenameTagsInApplicationType(Guid applicationTypeId);

Checks whether the accessing user can rename tags in bulk for a specific application

Parameters

Name	Type	Description	Required	Default	Options
applicationTypeId	`Guid`	Application type Id	Required

Return Type

bool

AdditionalInfo Delete(string tag, TagDeleteOptions options);

Parameters

Name	Type	Description	Required	Default	Options
tag	`string`	Tag's value	Required
options	`TagDeleteOptions`	Tag delete options	Required

Return Type

AdditionalInfo

ApiList<ContentTag> Get(Guid contentId, Guid contentTypeId, Guid? typeId);

Get tags for a piece of content.

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content type Id	Required
typeId	`Guid?`	Categorization type	Required

Return Type

ApiList<ContentTag>

ApiList<ContentTag> Get(string contentUrl, Guid oauthClientId, Guid? typeId);

Get tags for a piece of content.

Parameters

Name	Type	Description	Required
contentUrl	`string`	Content Url	Required
oauthClientId	`Guid`	Oauth client Id	Required
typeId	`Guid?`	Categorization type	Required

Return Type

ApiList<ContentTag>

PagedList<Tag> List(TagListOptions query = null);

Lists tags. This method is supported for backwards compatibility, but $core_v2_tags.List() should be used if possible.

Parameters

Name	Type	Description	Required	Default	Options
query	`TagListOptions`	Tag list Get options	Optional

Return Type

PagedList<Tag>

AdditionalInfo Remove(string contentUrl, Guid oauthClientId, Guid? typeId, string tags);

Remove a tag or tags from a piece of content.

Parameters

Name	Type	Description	Required
contentUrl	`string`	Content Url	Required
oauthClientId	`Guid`	Oauth client Id	Required
typeId	`Guid?`	Categorization type	Required
tags	`string`	Comma-separated list of tags	Required

Return Type

AdditionalInfo

AdditionalInfo Remove(Guid contentId, Guid contentTypeId, Guid? typeId, string tags);

Remove a tag or tags from a piece of content.

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content type Id	Required
typeId	`Guid?`	Categorization type	Required
tags	`string`	Comma-separated list of tags	Required

Return Type

AdditionalInfo

AdditionalInfo Rename(string originalTag, string replacementTag, TagRenameOptions options);

Rename a tag.

Parameters

Name	Type	Description	Required
originalTag	`string`	Original tag's value	Required
replacementTag	`string`	Replacement tag's value	Required
options	`TagRenameOptions`	Tag rename options	Required

Return Type

AdditionalInfo

AdditionalInfo Set(Guid contentId, Guid contentTypeId, Guid? typeId, string tags);

Set tags for a piece of content.

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content type Id	Required
typeId	`Guid?`	Categorization type	Required
tags	`string`	Comma-separated list of tags	Required

Return Type

AdditionalInfo

AdditionalInfo Set(string contentUrl, Guid oauthClientId, Guid? typeId, string tags);

Set tags for a piece of content.

Parameters

Name	Type	Description	Required
contentUrl	`string`	Content Url	Required
oauthClientId	`Guid`	Oauth client Id	Required
typeId	`Guid?`	Categorization type	Required
tags	`string`	Comma-separated list of tags	Required

Return Type

AdditionalInfo

ApiList<Tag> Sort(IList<Tag> tags, TagsSortOptions options = null);

Take a list of tags and filter them

Parameters

Name	Type	Description	Required	Default	Options
tags	`IList<Tag>`	List of unsorted tags	Required
options	`TagsSortOptions`	Tags sort options	Optional

Return Type

ApiList<Tag>

bool SupportsTags(Guid contentTypeId);

Check whether the content type supports tagging.

Parameters

Name	Type	Description	Required	Default	Options
contentTypeId	`Guid`	Content type Id	Required

Return Type

bool

Recommended