Interface IMacroService

Defines the MacroService, which is an easy access to operations involving IMacro

Namespace: Umbraco.Cms.Core.Services

Assembly: Umbraco.Core.dll

Syntax

public interface IMacroService : IService

Methods

View Source

Delete(IMacro, Int32)

Deletes an IMacro

Declaration

void Delete(IMacro macro, int userId = null)

Parameters

Type	Name	Description
IMacro	macro	IMacro to delete
System.Int32	userId	Optional id of the user deleting the macro

View Source

GetAll()

Declaration

IEnumerable<IMacro> GetAll()

Returns

Type	Description
IEnumerable<IMacro>

View Source

GetAll(Guid[])

Declaration

IEnumerable<IMacro> GetAll(params Guid[] ids)

Parameters

Type	Name	Description
Guid[]	ids

Returns

Type	Description
IEnumerable<IMacro>

View Source

GetAll(Int32[])

Declaration

IEnumerable<IMacro> GetAll(params int[] ids)

Parameters

Type	Name	Description
System.Int32[]	ids

Returns

Type	Description
IEnumerable<IMacro>

View Source

GetByAlias(String)

Gets an IMacro object by its alias

Declaration

IMacro GetByAlias(string alias)

Parameters

Type	Name	Description
System.String	alias	Alias to retrieve an IMacro for

Returns

Type	Description
IMacro	An IMacro object

View Source

GetById(Guid)

Declaration

IMacro GetById(Guid id)

Parameters

Type	Name	Description
Guid	id

Returns

Type	Description
IMacro

View Source

GetById(Int32)

Declaration

IMacro GetById(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
IMacro

View Source

Save(IMacro, Int32)

Saves an IMacro

Declaration

void Save(IMacro macro, int userId = null)

Parameters

Type	Name	Description
IMacro	macro	IMacro to save
System.Int32	userId	Optional id of the user saving the macro