Class MediaService

Represents the Media Service, which is an easy access to operations involving

Inheritance

System.Object

RepositoryService

Namespace: Umbraco.Cms.Core.Services.Implement

Assembly: cs.temp.dll.dll

Syntax

public class MediaService : RepositoryService

Constructors

MediaService(IScopeProvider, MediaFileManager, ILoggerFactory, IEventMessagesFactory, IMediaRepository, IAuditRepository, IMediaTypeRepository, IEntityRepository, IShortStringHelper)

Declaration

public MediaService(IScopeProvider provider, MediaFileManager mediaFileManager, ILoggerFactory loggerFactory, IEventMessagesFactory eventMessagesFactory, IMediaRepository mediaRepository, IAuditRepository auditRepository, IMediaTypeRepository mediaTypeRepository, IEntityRepository entityRepository, IShortStringHelper shortStringHelper)

Parameters

Type	Name	Description
IScopeProvider	provider
MediaFileManager	mediaFileManager
ILoggerFactory	loggerFactory
IEventMessagesFactory	eventMessagesFactory
IMediaRepository	mediaRepository
IAuditRepository	auditRepository
IMediaTypeRepository	mediaTypeRepository
IEntityRepository	entityRepository
IShortStringHelper	shortStringHelper

Methods

CheckDataIntegrity(ContentDataIntegrityReportOptions)

Declaration

public ContentDataIntegrityReport CheckDataIntegrity(ContentDataIntegrityReportOptions options)

Parameters

Type	Name	Description
ContentDataIntegrityReportOptions	options

Returns

Type	Description
ContentDataIntegrityReport

Count(String)

Declaration

public int Count(string mediaTypeAlias = null)

Parameters

Type	Name	Description
System.String	mediaTypeAlias

Returns

Type	Description
System.Int32

CountChildren(Int32, String)

Declaration

public int CountChildren(int parentId, string mediaTypeAlias = null)

Parameters

Type	Name	Description
System.Int32	parentId
System.String	mediaTypeAlias

Returns

Type	Description
System.Int32

CountDescendants(Int32, String)

Declaration

public int CountDescendants(int parentId, string mediaTypeAlias = null)

Parameters

Type	Name	Description
System.Int32	parentId
System.String	mediaTypeAlias

Returns

Type	Description
System.Int32

CountNotTrashed(String)

Declaration

public int CountNotTrashed(string mediaTypeAlias = null)

Parameters

Type	Name	Description
System.String	mediaTypeAlias

Returns

Type	Description
System.Int32

CreateMedia(String, IMedia, String, Int32)

Creates an object of a specified media type, under a parent.

Declaration

public IMedia CreateMedia(string name, IMedia parent, string mediaTypeAlias, int userId = default(int))

Parameters

Type	Name	Description
System.String	name	The name of the media object.
IMedia	parent	The parent media object.
System.String	mediaTypeAlias	The alias of the media type.
System.Int32	userId	The optional id of the user creating the media.

Returns

Type	Description
IMedia	The media object.

Remarks

This method simply returns a new, non-persisted, IMedia without any identity. It is intended as a shortcut to creating new media objects that does not invoke a save operation against the database.

CreateMedia(String, Guid, String, Int32)

Creates an object using the alias of the that this Media should based on.

Declaration

public IMedia CreateMedia(string name, Guid parentId, string mediaTypeAlias, int userId = default(int))

Parameters

Type	Name	Description
System.String	name	Name of the Media object
System.Guid	parentId	Id of Parent for the new Media item
System.String	mediaTypeAlias	Alias of the
System.Int32	userId	Optional id of the user creating the media item

Returns

Type	Description
IMedia

Remarks

Note that using this method will simply return a new IMedia without any identity as it has not yet been persisted. It is intended as a shortcut to creating new media objects that does not invoke a save operation against the database.

CreateMedia(String, Int32, String, Int32)

Creates an object of a specified media type.

Declaration

public IMedia CreateMedia(string name, int parentId, string mediaTypeAlias, int userId = default(int))

Parameters

Type	Name	Description
System.String	name	The name of the media object.
System.Int32	parentId	The identifier of the parent, or -1.
System.String	mediaTypeAlias	The alias of the media type.
System.Int32	userId	The optional id of the user creating the media.

Returns

Type	Description
IMedia	The media object.

Remarks

This method simply returns a new, non-persisted, IMedia without any identity. It is intended as a shortcut to creating new media objects that does not invoke a save operation against the database.

CreateMedia(String, String, Int32)

Creates an object of a specified media type, at root.

Declaration

public IMedia CreateMedia(string name, string mediaTypeAlias, int userId = default(int))

Parameters

Type	Name	Description
System.String	name	The name of the media object.
System.String	mediaTypeAlias	The alias of the media type.
System.Int32	userId	The optional id of the user creating the media.

Returns

Type	Description
IMedia	The media object.

Remarks

This method simply returns a new, non-persisted, IMedia without any identity. It is intended as a shortcut to creating new media objects that does not invoke a save operation against the database.

CreateMediaWithIdentity(String, IMedia, String, Int32)

Creates an object of a specified media type, under a parent.

Declaration

public IMedia CreateMediaWithIdentity(string name, IMedia parent, string mediaTypeAlias, int userId = default(int))

Parameters

Type	Name	Description
System.String	name	The name of the media object.
IMedia	parent	The parent media object.
System.String	mediaTypeAlias	The alias of the media type.
System.Int32	userId	The optional id of the user creating the media.

Returns

Type	Description
IMedia	The media object.

Remarks

This method returns a new, persisted, IMedia with an identity.

CreateMediaWithIdentity(String, Int32, String, Int32)

Creates an object of a specified media type.

Declaration

public IMedia CreateMediaWithIdentity(string name, int parentId, string mediaTypeAlias, int userId = default(int))

Parameters

Type	Name	Description
System.String	name	The name of the media object.
System.Int32	parentId	The identifier of the parent, or -1.
System.String	mediaTypeAlias	The alias of the media type.
System.Int32	userId	The optional id of the user creating the media.

Returns

Type	Description
IMedia	The media object.

Remarks

This method returns a new, persisted, IMedia with an identity.

Delete(IMedia, Int32)

Permanently deletes an object

Declaration

public Attempt<OperationResult> Delete(IMedia media, int userId = default(int))

Parameters

Type	Name	Description
IMedia	media	The to delete
System.Int32	userId	Id of the User deleting the Media

Returns

Type	Description
Attempt<OperationResult>

DeleteMediaFile(String)

Declaration

public void DeleteMediaFile(string filepath)

Parameters

Type	Name	Description
System.String	filepath

DeleteMediaOfType(Int32, Int32)

Deletes all media of specified type. All children of deleted media is moved to Recycle Bin.

Declaration

public void DeleteMediaOfType(int mediaTypeId, int userId = default(int))

Parameters

Type	Name	Description
System.Int32	mediaTypeId	Id of the
System.Int32	userId	Optional id of the user deleting the media

Remarks

This needs extra care and attention as its potentially a dangerous and extensive operation

DeleteMediaOfTypes(IEnumerable<Int32>, Int32)

Deletes all media of specified type. All children of deleted media is moved to Recycle Bin.

Declaration

public void DeleteMediaOfTypes(IEnumerable<int> mediaTypeIds, int userId = default(int))

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	mediaTypeIds	Id of the
System.Int32	userId	Optional id of the user deleting the media

Remarks

This needs extra care and attention as its potentially a dangerous and extensive operation.

Deletes media items of the specified type, and only that type. Does not handle content types inheritance and compositions, which need to be managed outside of this method.

DeleteVersion(Int32, Int32, Boolean, Int32)

Permanently deletes specific version(s) from an object. This method will never delete the latest version of a media item.

Declaration

public void DeleteVersion(int id, int versionId, bool deletePriorVersions, int userId = default(int))

Parameters

Type	Name	Description
System.Int32	id	Id of the object to delete a version from
System.Int32	versionId	Id of the version to delete
System.Boolean	deletePriorVersions	Boolean indicating whether to delete versions prior to the versionId
System.Int32	userId	Optional Id of the User deleting versions of a Media object

DeleteVersions(Int32, DateTime, Int32)

Permanently deletes versions from an object prior to a specific date. This method will never delete the latest version of a media item.

Declaration

public void DeleteVersions(int id, DateTime versionDate, int userId = default(int))

Parameters

Type	Name	Description
System.Int32	id	Id of the object to delete versions from
System.DateTime	versionDate	Latest version date
System.Int32	userId	Optional Id of the User deleting versions of a Media object

EmptyRecycleBin(Int32)

Empties the Recycle Bin by deleting all that resides in the bin

Declaration

public OperationResult EmptyRecycleBin(int userId = default(int))

Parameters

Type	Name	Description
System.Int32	userId	Optional Id of the User emptying the Recycle Bin

Returns

Type	Description
OperationResult

GetAncestors(IMedia)

Gets a collection of objects, which are ancestors of the current media.

Declaration

public IEnumerable<IMedia> GetAncestors(IMedia media)

Parameters

Type	Name	Description
IMedia	media	to retrieve ancestors for

Returns

Type	Description
System.Collections.Generic.IEnumerable<IMedia>	An Enumerable list of objects

GetAncestors(Int32)

Gets a collection of objects, which are ancestors of the current media.

Declaration

public IEnumerable<IMedia> GetAncestors(int id)

Parameters

Type	Name	Description
System.Int32	id	Id of the to retrieve ancestors for

Returns

Type	Description
System.Collections.Generic.IEnumerable<IMedia>	An Enumerable list of objects

GetById(Guid)

Gets an object by its 'UniqueId'

Declaration

public IMedia GetById(Guid key)

Parameters

Type	Name	Description
System.Guid	key	Guid key of the Media to retrieve

Returns

Type	Description
IMedia

GetById(Int32)

Gets an object by Id

Declaration

public IMedia GetById(int id)

Parameters

Type	Name	Description
System.Int32	id	Id of the Media to retrieve

Returns

Type	Description
IMedia

GetByIds(IEnumerable<Guid>)

Gets an object by Id

Declaration

public IEnumerable<IMedia> GetByIds(IEnumerable<Guid> ids)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Guid>	ids	Ids of the Media to retrieve

Returns

Type	Description
System.Collections.Generic.IEnumerable<IMedia>

GetByIds(IEnumerable<Int32>)

Gets an object by Id

Declaration

public IEnumerable<IMedia> GetByIds(IEnumerable<int> ids)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	ids	Ids of the Media to retrieve

Returns

Type	Description
System.Collections.Generic.IEnumerable<IMedia>

GetByLevel(Int32)

Gets a collection of objects by Level

Declaration

public IEnumerable<IMedia> GetByLevel(int level)

Parameters

Type	Name	Description
System.Int32	level	The level to retrieve Media from

Returns

Type	Description
System.Collections.Generic.IEnumerable<IMedia>	An Enumerable list of objects

Remarks

Contrary to most methods, this method filters out trashed media items.

GetMediaByPath(String)

Gets an object from the path stored in the 'umbracoFile' property.

Declaration

public IMedia GetMediaByPath(string mediaPath)

Parameters

Type	Name	Description
System.String	mediaPath	Path of the media item to retrieve (for example: /media/1024/koala_403x328.jpg)

Returns

Type	Description
IMedia

GetMediaFileContentStream(String)

Declaration

public Stream GetMediaFileContentStream(string filepath)

Parameters

Type	Name	Description
System.String	filepath

Returns

Type	Description
Stream

GetMediaFileSize(String)

Declaration

public long GetMediaFileSize(string filepath)

Parameters

Type	Name	Description
System.String	filepath

Returns

Type	Description
System.Int64

GetPagedChildren(Int32, Int64, Int32, out Int64, IQuery<IMedia>, Ordering)

Declaration

public IEnumerable<IMedia> GetPagedChildren(int id, long pageIndex, int pageSize, out long totalChildren, IQuery<IMedia> filter = null, Ordering ordering = null)

Parameters

Type	Name	Description
System.Int32	id
System.Int64	pageIndex
System.Int32	pageSize
System.Int64	totalChildren
IQuery<IMedia>	filter
Ordering	ordering

Returns

Type	Description
System.Collections.Generic.IEnumerable<IMedia>

GetPagedDescendants(Int32, Int64, Int32, out Int64, IQuery<IMedia>, Ordering)

Declaration

public IEnumerable<IMedia> GetPagedDescendants(int id, long pageIndex, int pageSize, out long totalChildren, IQuery<IMedia> filter = null, Ordering ordering = null)

Parameters

Type	Name	Description
System.Int32	id
System.Int64	pageIndex
System.Int32	pageSize
System.Int64	totalChildren
IQuery<IMedia>	filter
Ordering	ordering

Returns

Type	Description
System.Collections.Generic.IEnumerable<IMedia>

GetPagedMediaInRecycleBin(Int64, Int32, out Int64, IQuery<IMedia>, Ordering)

Declaration

public IEnumerable<IMedia> GetPagedMediaInRecycleBin(long pageIndex, int pageSize, out long totalRecords, IQuery<IMedia> filter = null, Ordering ordering = null)

Parameters

Type	Name	Description
System.Int64	pageIndex
System.Int32	pageSize
System.Int64	totalRecords
IQuery<IMedia>	filter
Ordering	ordering

Returns

Type	Description
System.Collections.Generic.IEnumerable<IMedia>

GetPagedOfType(Int32, Int64, Int32, out Int64, IQuery<IMedia>, Ordering)

Declaration

public IEnumerable<IMedia> GetPagedOfType(int contentTypeId, long pageIndex, int pageSize, out long totalRecords, IQuery<IMedia> filter = null, Ordering ordering = null)

Parameters

Type	Name	Description
System.Int32	contentTypeId
System.Int64	pageIndex
System.Int32	pageSize
System.Int64	totalRecords
IQuery<IMedia>	filter
Ordering	ordering

Returns

Type	Description
System.Collections.Generic.IEnumerable<IMedia>

GetPagedOfTypes(Int32[], Int64, Int32, out Int64, IQuery<IMedia>, Ordering)

Declaration

public IEnumerable<IMedia> GetPagedOfTypes(int[] contentTypeIds, long pageIndex, int pageSize, out long totalRecords, IQuery<IMedia> filter = null, Ordering ordering = null)

Parameters

Type	Name	Description
System.Int32[]	contentTypeIds
System.Int64	pageIndex
System.Int32	pageSize
System.Int64	totalRecords
IQuery<IMedia>	filter
Ordering	ordering

Returns

Type	Description
System.Collections.Generic.IEnumerable<IMedia>

GetParent(IMedia)

Gets the parent of the current media as an item.

Declaration

public IMedia GetParent(IMedia media)

Parameters

Type	Name	Description
IMedia	media	to retrieve the parent from

Returns

Type	Description
IMedia	Parent object

GetParent(Int32)

Gets the parent of the current media as an item.

Declaration

public IMedia GetParent(int id)

Parameters

Type	Name	Description
System.Int32	id	Id of the to retrieve the parent from

Returns

Type	Description
IMedia	Parent object

GetRootMedia()

Gets a collection of objects, which reside at the first level / root

Declaration

public IEnumerable<IMedia> GetRootMedia()

Returns

Type	Description
System.Collections.Generic.IEnumerable<IMedia>	An Enumerable list of objects

GetVersion(Int32)

Gets a specific version of an item.

Declaration

public IMedia GetVersion(int versionId)

Parameters

Type	Name	Description
System.Int32	versionId	Id of the version to retrieve

Returns

Type	Description
IMedia	An item

GetVersions(Int32)

Gets a collection of an objects versions by Id

Declaration

public IEnumerable<IMedia> GetVersions(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
System.Collections.Generic.IEnumerable<IMedia>	An Enumerable list of objects

HasChildren(Int32)

Checks whether an item has any children

Declaration

public bool HasChildren(int id)

Parameters

Type	Name	Description
System.Int32	id	Id of the

Returns

Type	Description
System.Boolean	True if the media has any children otherwise False

Move(IMedia, Int32, Int32)

Moves an object to a new location

Declaration

public Attempt<OperationResult> Move(IMedia media, int parentId, int userId = default(int))

Parameters

Type	Name	Description
IMedia	media	The to move
System.Int32	parentId	Id of the Media's new Parent
System.Int32	userId	Id of the User moving the Media

Returns

Type	Description
Attempt<OperationResult>

MoveToRecycleBin(IMedia, Int32)

Deletes an object by moving it to the Recycle Bin

Declaration

public Attempt<OperationResult> MoveToRecycleBin(IMedia media, int userId = default(int))

Parameters

Type	Name	Description
IMedia	media	The to delete
System.Int32	userId	Id of the User deleting the Media

Returns

Type	Description
Attempt<OperationResult>

RecycleBinSmells()

Declaration

public bool RecycleBinSmells()

Returns

Type	Description
System.Boolean

Save(IMedia, Int32)

Saves a single object

Declaration

public Attempt<OperationResult> Save(IMedia media, int userId = default(int))

Parameters

Type	Name	Description
IMedia	media	The to save
System.Int32	userId	Id of the User saving the Media

Returns

Type	Description
Attempt<OperationResult>

Save(IEnumerable<IMedia>, Int32)

Saves a collection of objects

Declaration

public Attempt<OperationResult> Save(IEnumerable<IMedia> medias, int userId = default(int))

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<IMedia>	medias	Collection of to save
System.Int32	userId	Id of the User saving the Media

Returns

Type	Description
Attempt<OperationResult>

SetMediaFileContent(String, Stream)

Declaration

public void SetMediaFileContent(string filepath, Stream stream)

Parameters

Type	Name	Description
System.String	filepath
Stream	stream

Sort(IEnumerable<IMedia>, Int32)

Sorts a collection of objects by updating the SortOrder according to the ordering of items in the passed in System.Collections.Generic.IEnumerable<T>.

Declaration

public bool Sort(IEnumerable<IMedia> items, int userId = default(int))

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<IMedia>	items
System.Int32	userId

Returns

Type	Description
System.Boolean	True if sorting succeeded, otherwise False