Interface ITagService
Namespace:System.Dynamic.ExpandoObject
Assembly:Umbraco.Core.dll
Syntax
public interface ITagService : IService
Methods
GetAllContentTags(String)
Gets all tags for content items
Declaration
IEnumerable<ITag> GetAllContentTags(string tagGroup = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | tagGroup | Optional name of the 'Tag Group' |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<ITag> | An enumerable list of ITag |
Remarks
Use the optional tagGroup parameter to limit the result to a specific 'Tag Group'.
GetAllMediaTags(String)
Gets all tags for media items
Declaration
IEnumerable<ITag> GetAllMediaTags(string tagGroup = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | tagGroup | Optional name of the 'Tag Group' |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<ITag> | An enumerable list of ITag |
Remarks
Use the optional tagGroup parameter to limit the result to a specific 'Tag Group'.
GetAllMemberTags(String)
Gets all tags for member items
Declaration
IEnumerable<ITag> GetAllMemberTags(string tagGroup = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | tagGroup | Optional name of the 'Tag Group' |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<ITag> | An enumerable list of ITag |
Remarks
Use the optional tagGroup parameter to limit the result to a specific 'Tag Group'.
GetAllTags(String)
Gets every tag stored in the database
Declaration
IEnumerable<ITag> GetAllTags(string tagGroup = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | tagGroup | Optional name of the 'Tag Group' |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<ITag> | An enumerable list of ITag |
GetTaggedContentByTag(String, String)
Gets tagged Content by a specific 'Tag' and optional 'Tag Group'.
Declaration
IEnumerable<TaggedEntity> GetTaggedContentByTag(string tag, string tagGroup = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | tag | Tag |
System.String | tagGroup | Optional name of the 'Tag Group' |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<TaggedEntity> | An enumerable list of TaggedEntity |
Remarks
The TaggedEntity contains the Id and Tags of the Content, not the actual Content item.
GetTaggedContentByTagGroup(String)
Gets tagged Content by a specific 'Tag Group'.
Declaration
IEnumerable<TaggedEntity> GetTaggedContentByTagGroup(string tagGroup)
Parameters
Type | Name | Description |
---|---|---|
System.String | tagGroup | Name of the 'Tag Group' |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<TaggedEntity> | An enumerable list of TaggedEntity |
Remarks
The TaggedEntity contains the Id and Tags of the Content, not the actual Content item.
GetTaggedEntityById(Int32)
Declaration
TaggedEntity GetTaggedEntityById(int id)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id |
Returns
Type | Description |
---|---|
TaggedEntity |
GetTaggedEntityByKey(Guid)
Declaration
TaggedEntity GetTaggedEntityByKey(Guid key)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | key |
Returns
Type | Description |
---|---|
TaggedEntity |
GetTaggedMediaByTag(String, String)
Gets tagged Media by a specific 'Tag' and optional 'Tag Group'.
Declaration
IEnumerable<TaggedEntity> GetTaggedMediaByTag(string tag, string tagGroup = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | tag | Tag |
System.String | tagGroup | Optional name of the 'Tag Group' |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<TaggedEntity> | An enumerable list of TaggedEntity |
Remarks
The TaggedEntity contains the Id and Tags of the Media, not the actual Media item.
GetTaggedMediaByTagGroup(String)
Gets tagged Media by a specific 'Tag Group'.
Declaration
IEnumerable<TaggedEntity> GetTaggedMediaByTagGroup(string tagGroup)
Parameters
Type | Name | Description |
---|---|---|
System.String | tagGroup | Name of the 'Tag Group' |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<TaggedEntity> | An enumerable list of TaggedEntity |
Remarks
The TaggedEntity contains the Id and Tags of the Media, not the actual Media item.
GetTaggedMembersByTag(String, String)
Gets tagged Members by a specific 'Tag' and optional 'Tag Group'.
Declaration
IEnumerable<TaggedEntity> GetTaggedMembersByTag(string tag, string tagGroup = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | tag | Tag |
System.String | tagGroup | Optional name of the 'Tag Group' |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<TaggedEntity> | An enumerable list of TaggedEntity |
Remarks
The TaggedEntity contains the Id and Tags of the Member, not the actual Member item.
GetTaggedMembersByTagGroup(String)
Gets tagged Members by a specific 'Tag Group'.
Declaration
IEnumerable<TaggedEntity> GetTaggedMembersByTagGroup(string tagGroup)
Parameters
Type | Name | Description |
---|---|---|
System.String | tagGroup | Name of the 'Tag Group' |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<TaggedEntity> | An enumerable list of TaggedEntity |
Remarks
The TaggedEntity contains the Id and Tags of the Member, not the actual Member item.
GetTagsForEntity(Guid, String)
Gets all tags attached to an entity (content, media or member) by entity id
Declaration
IEnumerable<ITag> GetTagsForEntity(Guid contentId, string tagGroup = null)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | contentId | The content item id to get tags for |
System.String | tagGroup | Optional name of the 'Tag Group' |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<ITag> | An enumerable list of ITag |
Remarks
Use the optional tagGroup parameter to limit the result to a specific 'Tag Group'.
GetTagsForEntity(Int32, String)
Gets all tags attached to an entity (content, media or member) by entity id
Declaration
IEnumerable<ITag> GetTagsForEntity(int contentId, string tagGroup = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | contentId | The content item id to get tags for |
System.String | tagGroup | Optional name of the 'Tag Group' |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<ITag> | An enumerable list of ITag |
Remarks
Use the optional tagGroup parameter to limit the result to a specific 'Tag Group'.
GetTagsForProperty(Guid, String, String)
Gets all tags attached to a property by entity id
Declaration
IEnumerable<ITag> GetTagsForProperty(Guid contentId, string propertyTypeAlias, string tagGroup = null)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | contentId | The content item id to get tags for |
System.String | propertyTypeAlias | Property type alias |
System.String | tagGroup | Optional name of the 'Tag Group' |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<ITag> | An enumerable list of ITag |
Remarks
Use the optional tagGroup parameter to limit the result to a specific 'Tag Group'.
GetTagsForProperty(Int32, String, String)
Gets all tags attached to a property by entity id
Declaration
IEnumerable<ITag> GetTagsForProperty(int contentId, string propertyTypeAlias, string tagGroup = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | contentId | The content item id to get tags for |
System.String | propertyTypeAlias | Property type alias |
System.String | tagGroup | Optional name of the 'Tag Group' |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<ITag> | An enumerable list of ITag |
Remarks
Use the optional tagGroup parameter to limit the result to a specific 'Tag Group'.