Tags In-Process API Service - Telligent Evolution 7.x Developer Documentation - Developer Space

Telligent.Evolution.Extensibility.Api.Version1.PublicApi.Tags 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);

Parameters

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

Return Type

AdditionalInfo

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

Parameters

Name	Type	Description	Required
contentUrl	`string`	Content Url	Required
applicationId	`Guid`	Application Id	Required
typeId	`Guid?`	Type Id	Required
tags	`string`	Tags	Required

Return Type

AdditionalInfo

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

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
typeId	`Guid?`	Type Id	Required
tags	`string`	Tags	Required

Return Type

AdditionalInfo

bool CanAddTags(Guid contentId, Guid contentTypeId);

Parameters

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

Return Type

bool

bool CanAddTagsInApplication(Guid applicationId, Guid applicationTypeId);

Parameters

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

Return Type

bool

bool CanAddTagsInApplicationType(Guid applicationTypeId);

Parameters

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

Return Type

bool

bool CanDeleteTagsInApplication(Guid applicationId, Guid applicationTypeId);

Parameters

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

Return Type

bool

bool CanDeleteTagsInApplicationType(Guid applicationTypeId);

Parameters

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

Return Type

bool

bool CanRemoveTags(Guid contentId, Guid contentTypeId);

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);

Parameters

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

Return Type

bool

bool CanRenameTagsInApplicationType(Guid applicationTypeId);

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	Required
options	`TagDeleteOptions`	Options	Required

Return Type

AdditionalInfo

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

Parameters

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

Return Type

ApiList<ContentTag>

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

Parameters

Name	Type	Description	Required
contentUrl	`string`	Content Url	Required
applicationId	`Guid`	Application Id	Required
typeId	`Guid?`	Type Id	Required

Return Type

ApiList<ContentTag>

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

Parameters

Name	Type	Description	Required	Default	Options
query	`TagListOptions`	Query	Optional

Return Type

PagedList<Tag>

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

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
typeId	`Guid?`	Type Id	Required
tags	`string`	Tags	Required

Return Type

AdditionalInfo

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

Parameters

Name	Type	Description	Required
contentUrl	`string`	Content Url	Required
applicationId	`Guid`	Application Id	Required
typeId	`Guid?`	Type Id	Required
tags	`string`	Tags	Required

Return Type

AdditionalInfo

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

Parameters

Name	Type	Description	Required
originalTag	`string`	Original Tag	Required
replacementTag	`string`	Replacement Tag	Required
options	`TagRenameOptions`	Options	Required

Return Type

AdditionalInfo

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

Parameters

Name	Type	Description	Required
contentUrl	`string`	Content Url	Required
applicationId	`Guid`	Application Id	Required
typeId	`Guid?`	Type Id	Required
tags	`string`	Tags	Required

Return Type

AdditionalInfo

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

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
typeId	`Guid?`	Type Id	Required
tags	`string`	Tags	Required

Return Type

AdditionalInfo

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

Parameters

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

Return Type

ApiList<Tag>

bool SupportsTags(Guid contentTypeId);

Parameters

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

Return Type

bool

Notes

When renaming and deleting tags, only the following contexts are supported in core applications:

Blogs: Only a single application context is supported. An ApplicationTypeId and ApplicationId must be specified.
Forums: Only an application type context is supported. ApplicationTypeId must be specified.
Wikis: At this time, wikis does not support tag moderation.
Media Galleries: Only a single application context is supported. An ApplicationTypeId and ApplicationId must be specified.