Search Results for

    Show / Hide Table of Contents
    View Source

    Interface IContentPublishingService

    Namespace: Umbraco.Cms.Core.Services
    Assembly: Umbraco.Core.dll
    Syntax
    public interface IContentPublishingService

    Methods

    View Source

    GetPublishBranchResultAsync(Guid)

    Retrieves the result of a background task that has published a content branch.

    Declaration
    virtual Task<Attempt<ContentPublishingBranchResult, ContentPublishingOperationStatus>> GetPublishBranchResultAsync(Guid taskId)
    Parameters
    Type Name Description
    Guid taskId

    The task Id.

    Returns
    Type Description
    Task<Attempt<ContentPublishingBranchResult, ContentPublishingOperationStatus>>

    Result of the publish operation.

    View Source

    IsPublishingBranchAsync(Guid)

    Gets the status of a background task that is publishing a content branch.

    Declaration
    virtual Task<bool> IsPublishingBranchAsync(Guid taskId)
    Parameters
    Type Name Description
    Guid taskId

    The task Id.

    Returns
    Type Description
    Task<System.Boolean>

    True if the requested publish branch tag is still in process.

    View Source

    PublishAsync(Guid, ICollection<CulturePublishScheduleModel>, Guid)

    Publishes a single content item.

    Declaration
    virtual Task<Attempt<ContentPublishingResult, ContentPublishingOperationStatus>> PublishAsync(Guid key, ICollection<CulturePublishScheduleModel> culturesToPublishOrSchedule, Guid userKey)
    Parameters
    Type Name Description
    Guid key

    The key of the root content.

    ICollection<CulturePublishScheduleModel> culturesToPublishOrSchedule

    The cultures to publish or schedule.

    Guid userKey

    The identifier of the user performing the operation.

    Returns
    Type Description
    Task<Attempt<ContentPublishingResult, ContentPublishingOperationStatus>>
    View Source

    PublishAsync(Guid, CultureAndScheduleModel, Guid)

    Publishes a single content item.

    Declaration
    Task<Attempt<ContentPublishingResult, ContentPublishingOperationStatus>> PublishAsync(Guid key, CultureAndScheduleModel cultureAndSchedule, Guid userKey)
    Parameters
    Type Name Description
    Guid key

    The key of the root content.

    CultureAndScheduleModel cultureAndSchedule

    The cultures to publish and their publishing schedules.

    Guid userKey

    The identifier of the user performing the operation.

    Returns
    Type Description
    Task<Attempt<ContentPublishingResult, ContentPublishingOperationStatus>>

    Result of the publish operation.

    View Source

    PublishBranchAsync(Guid, IEnumerable<String>, Boolean, Guid)

    Publishes a content branch.

    Declaration
    Task<Attempt<ContentPublishingBranchResult, ContentPublishingOperationStatus>> PublishBranchAsync(Guid key, IEnumerable<string> cultures, bool force, Guid userKey)
    Parameters
    Type Name Description
    Guid key

    The key of the root content.

    IEnumerable<System.String> cultures

    The cultures to publish.

    System.Boolean force

    A value indicating whether to force-publish content that is not already published.

    Guid userKey

    The identifier of the user performing the operation.

    Returns
    Type Description
    Task<Attempt<ContentPublishingBranchResult, ContentPublishingOperationStatus>>

    Result of the publish operation.

    View Source

    PublishBranchAsync(Guid, IEnumerable<String>, PublishBranchFilter, Guid)

    Publishes a content branch.

    Declaration
    virtual Task<Attempt<ContentPublishingBranchResult, ContentPublishingOperationStatus>> PublishBranchAsync(Guid key, IEnumerable<string> cultures, PublishBranchFilter publishBranchFilter, Guid userKey)
    Parameters
    Type Name Description
    Guid key

    The key of the root content.

    IEnumerable<System.String> cultures

    The cultures to publish.

    PublishBranchFilter publishBranchFilter

    A value indicating options for force publishing unpublished or re-publishing unchanged content.

    Guid userKey

    The identifier of the user performing the operation.

    Returns
    Type Description
    Task<Attempt<ContentPublishingBranchResult, ContentPublishingOperationStatus>>

    Result of the publish operation.

    View Source

    PublishBranchAsync(Guid, IEnumerable<String>, PublishBranchFilter, Guid, Boolean)

    Publishes a content branch.

    Declaration
    virtual Task<Attempt<ContentPublishingBranchResult, ContentPublishingOperationStatus>> PublishBranchAsync(Guid key, IEnumerable<string> cultures, PublishBranchFilter publishBranchFilter, Guid userKey, bool useBackgroundThread)
    Parameters
    Type Name Description
    Guid key

    The key of the root content.

    IEnumerable<System.String> cultures

    The cultures to publish.

    PublishBranchFilter publishBranchFilter

    A value indicating options for force publishing unpublished or re-publishing unchanged content.

    Guid userKey

    The identifier of the user performing the operation.

    System.Boolean useBackgroundThread

    Flag indicating whether to use a background thread for the operation and immediately return to the caller.

    Returns
    Type Description
    Task<Attempt<ContentPublishingBranchResult, ContentPublishingOperationStatus>>

    Result of the publish operation.

    View Source

    UnpublishAsync(Guid, Nullable<ISet<String>>, Guid)

    Unpublishes multiple cultures of a single content item.

    Declaration
    Task<Attempt<ContentPublishingOperationStatus>> UnpublishAsync(Guid key, ISet<string>? cultures, Guid userKey)
    Parameters
    Type Name Description
    Guid key

    The key of the root content.

    System.Nullable<ISet<System.String>> cultures

    The cultures to unpublish. Use null to unpublish all cultures.

    Guid userKey

    The identifier of the user performing the operation.

    Returns
    Type Description
    Task<Attempt<ContentPublishingOperationStatus>>

    Status of the publish operation.

    • Improve this Doc
    • View Source
    In This Article
    • Methods
      • GetPublishBranchResultAsync(Guid)
      • IsPublishingBranchAsync(Guid)
      • PublishAsync(Guid, ICollection<CulturePublishScheduleModel>, Guid)
      • PublishAsync(Guid, CultureAndScheduleModel, Guid)
      • PublishBranchAsync(Guid, IEnumerable<String>, Boolean, Guid)
      • PublishBranchAsync(Guid, IEnumerable<String>, PublishBranchFilter, Guid)
      • PublishBranchAsync(Guid, IEnumerable<String>, PublishBranchFilter, Guid, Boolean)
      • UnpublishAsync(Guid, Nullable<ISet<String>>, Guid)
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX