Interface IPartialViewService
Namespace: Umbraco.Cms.Core.Services
Assembly: Umbraco.Core.dll
Syntax
public interface IPartialViewService : IBasicFileService<IPartialView>Methods
View SourceCreateAsync(PartialViewCreateModel, Guid)
Creates a new partial view.
Declaration
Task<Attempt<IPartialView, PartialViewOperationStatus>> CreateAsync(PartialViewCreateModel createModel, Guid userKey)Parameters
| Type | Name | Description |
|---|---|---|
| PartialViewCreateModel | createModel | PartialViewCreateModel containing the information about the partial view being created. |
| Guid | userKey | The key of the user performing the operation. |
Returns
| Type | Description |
|---|---|
| Task<Attempt<IPartialView, PartialViewOperationStatus>> | An attempt indicating if the operation was a success as well as a more detailed PartialViewOperationStatus. |
DeleteAsync(String, Guid)
Deletes a partial view.
Declaration
Task<PartialViewOperationStatus> DeleteAsync(string path, Guid userKey)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path | The path of the partial view to delete. |
| Guid | userKey | The key of the user performing the operation. |
Returns
| Type | Description |
|---|---|
| Task<PartialViewOperationStatus> | An operation status. |
GetSnippetAsync(String)
Gets a partial view snippet by ID, returns null if not found.
Declaration
Task<PartialViewSnippet> GetSnippetAsync(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The name of the snippet to get. |
Returns
| Type | Description |
|---|---|
| Task<PartialViewSnippet> | The partial view snippet, null if not found. |
GetSnippetsAsync(Int32, Int32)
Gets all the available partial view snippets.
Declaration
Task<PagedModel<PartialViewSnippetSlim>> GetSnippetsAsync(int skip, int take)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | skip | Amount to skip. |
| System.Int32 | take | Amount to take. |
Returns
| Type | Description |
|---|---|
| Task<PagedModel<PartialViewSnippetSlim>> |
RenameAsync(String, PartialViewRenameModel, Guid)
Renames a partial view.
Declaration
Task<Attempt<IPartialView, PartialViewOperationStatus>> RenameAsync(string path, PartialViewRenameModel renameModel, Guid userKey)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path | The path of the partial view to rename. |
| PartialViewRenameModel | renameModel | A PartialViewRenameModel with the changes. |
| Guid | userKey | The key of the user performing the operation. |
Returns
| Type | Description |
|---|---|
| Task<Attempt<IPartialView, PartialViewOperationStatus>> | An attempt indicating if the operation was a success as well as a more detailed PartialViewOperationStatus. |
UpdateAsync(String, PartialViewUpdateModel, Guid)
Updates an existing partial view.
Declaration
Task<Attempt<IPartialView, PartialViewOperationStatus>> UpdateAsync(string path, PartialViewUpdateModel updateModel, Guid userKey)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path | The path of the partial view to update. |
| PartialViewUpdateModel | updateModel | A PartialViewUpdateModel with the changes. |
| Guid | userKey | The key of the user performing the operation. |
Returns
| Type | Description |
|---|---|
| Task<Attempt<IPartialView, PartialViewOperationStatus>> | An attempt indicating if the operation was a success as well as a more detailed PartialViewOperationStatus. |