Search Results for

    Show / Hide Table of Contents
    View Source

    Interface ITagService

    Tag service to query for tags in the tags db table. The tags returned are only relevant for published content & saved media or members

    Namespace: Umbraco.Cms.Core.Services
    Assembly: Umbraco.Core.dll
    Syntax
    public interface ITagService : IService
    Remarks

    If there is unpublished content with tags, those tags will not be contained. This service does not contain methods to query for content, media or members based on tags, those methods will be added to the content, media and member services respectively.

    Methods

    View Source

    GetAllContentTags(String, String)

    Gets all document tags.

    Declaration
    IEnumerable<ITag> GetAllContentTags(string group = null, string culture = null)
    Parameters
    Type Name Description
    System.String group
    System.String culture
    Returns
    Type Description
    IEnumerable<ITag>
    View Source

    GetAllMediaTags(String, String)

    Gets all media tags.

    Declaration
    IEnumerable<ITag> GetAllMediaTags(string group = null, string culture = null)
    Parameters
    Type Name Description
    System.String group
    System.String culture
    Returns
    Type Description
    IEnumerable<ITag>
    View Source

    GetAllMemberTags(String, String)

    Gets all member tags.

    Declaration
    IEnumerable<ITag> GetAllMemberTags(string group = null, string culture = null)
    Parameters
    Type Name Description
    System.String group
    System.String culture
    Returns
    Type Description
    IEnumerable<ITag>
    View Source

    GetAllTags(String, String)

    Gets all tags.

    Declaration
    IEnumerable<ITag> GetAllTags(string group = null, string culture = null)
    Parameters
    Type Name Description
    System.String group
    System.String culture
    Returns
    Type Description
    IEnumerable<ITag>
    View Source

    GetTaggedContentByTag(String, String, String)

    Gets all documents tagged with the specified tag.

    Declaration
    IEnumerable<TaggedEntity> GetTaggedContentByTag(string tag, string group = null, string culture = null)
    Parameters
    Type Name Description
    System.String tag
    System.String group
    System.String culture
    Returns
    Type Description
    IEnumerable<TaggedEntity>
    View Source

    GetTaggedContentByTagGroup(String, String)

    Gets all documents tagged with any tag in the specified group.

    Declaration
    IEnumerable<TaggedEntity> GetTaggedContentByTagGroup(string group, string culture = null)
    Parameters
    Type Name Description
    System.String group
    System.String culture
    Returns
    Type Description
    IEnumerable<TaggedEntity>
    View Source

    GetTaggedEntityById(Int32)

    Gets a tagged entity.

    Declaration
    TaggedEntity GetTaggedEntityById(int id)
    Parameters
    Type Name Description
    System.Int32 id
    Returns
    Type Description
    TaggedEntity
    View Source

    GetTaggedEntityByKey(Guid)

    Gets a tagged entity.

    Declaration
    TaggedEntity GetTaggedEntityByKey(Guid key)
    Parameters
    Type Name Description
    Guid key
    Returns
    Type Description
    TaggedEntity
    View Source

    GetTaggedMediaByTag(String, String, String)

    Gets all media tagged with the specified tag.

    Declaration
    IEnumerable<TaggedEntity> GetTaggedMediaByTag(string tag, string group = null, string culture = null)
    Parameters
    Type Name Description
    System.String tag
    System.String group
    System.String culture
    Returns
    Type Description
    IEnumerable<TaggedEntity>
    View Source

    GetTaggedMediaByTagGroup(String, String)

    Gets all media tagged with any tag in the specified group.

    Declaration
    IEnumerable<TaggedEntity> GetTaggedMediaByTagGroup(string group, string culture = null)
    Parameters
    Type Name Description
    System.String group
    System.String culture
    Returns
    Type Description
    IEnumerable<TaggedEntity>
    View Source

    GetTaggedMembersByTag(String, String, String)

    Gets all members tagged with the specified tag.

    Declaration
    IEnumerable<TaggedEntity> GetTaggedMembersByTag(string tag, string group = null, string culture = null)
    Parameters
    Type Name Description
    System.String tag
    System.String group
    System.String culture
    Returns
    Type Description
    IEnumerable<TaggedEntity>
    View Source

    GetTaggedMembersByTagGroup(String, String)

    Gets all members tagged with any tag in the specified group.

    Declaration
    IEnumerable<TaggedEntity> GetTaggedMembersByTagGroup(string group, string culture = null)
    Parameters
    Type Name Description
    System.String group
    System.String culture
    Returns
    Type Description
    IEnumerable<TaggedEntity>
    View Source

    GetTagsForEntity(Guid, String, String)

    Gets all tags attached to an entity.

    Declaration
    IEnumerable<ITag> GetTagsForEntity(Guid contentId, string group = null, string culture = null)
    Parameters
    Type Name Description
    Guid contentId
    System.String group
    System.String culture
    Returns
    Type Description
    IEnumerable<ITag>
    View Source

    GetTagsForEntity(Int32, String, String)

    Gets all tags attached to an entity.

    Declaration
    IEnumerable<ITag> GetTagsForEntity(int contentId, string group = null, string culture = null)
    Parameters
    Type Name Description
    System.Int32 contentId
    System.String group
    System.String culture
    Returns
    Type Description
    IEnumerable<ITag>
    View Source

    GetTagsForProperty(Guid, String, String, String)

    Gets all tags attached to an entity via a property.

    Declaration
    IEnumerable<ITag> GetTagsForProperty(Guid contentId, string propertyTypeAlias, string group = null, string culture = null)
    Parameters
    Type Name Description
    Guid contentId
    System.String propertyTypeAlias
    System.String group
    System.String culture
    Returns
    Type Description
    IEnumerable<ITag>
    View Source

    GetTagsForProperty(Int32, String, String, String)

    Gets all tags attached to an entity via a property.

    Declaration
    IEnumerable<ITag> GetTagsForProperty(int contentId, string propertyTypeAlias, string group = null, string culture = null)
    Parameters
    Type Name Description
    System.Int32 contentId
    System.String propertyTypeAlias
    System.String group
    System.String culture
    Returns
    Type Description
    IEnumerable<ITag>
    • Improve this Doc
    • View Source
    In This Article
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX