Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://apidocs.umbraco.com/v15/csharp/api/Umbraco.Cms.Core.Services.MediaService.html below:

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

System.Object

public class MediaService : RepositoryService, IMediaService, IContentServiceBase<IMedia>, IContentServiceBase, IService

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

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

public ContentDataIntegrityReport CheckDataIntegrity(ContentDataIntegrityReportOptions options)

public int Count(string mediaTypeAlias = null)

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

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

public int CountNotTrashed(string mediaTypeAlias = null)

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

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

Name of the Media object

Id of Parent for the new Media item

Alias of the IMediaType

Optional id of the user creating the media item

Creates an IMedia object of a specified media type.

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

The name of the media object.

The identifier of the parent, or -1.

The alias of the media type.

The optional id of the user creating the media.

The media object.

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

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

The name of the media object.

The alias of the media type.

The optional id of the user creating the media.

The media object.

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

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

The name of the media object.

The parent media object.

The alias of the media type.

The optional id of the user creating the media.

The media object.

Creates an IMedia object of a specified media type.

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

The name of the media object.

The identifier of the parent, or -1.

The alias of the media type.

The optional id of the user creating the media.

The media object.

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

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

The name of the media object.

The parent media object.

The alias of the media type.

The optional id of the user creating the media.

The media object.

Permanently deletes an IMedia object

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

The IMedia to delete

Id of the User deleting the Media

public void DeleteMediaFile(string filepath)

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

public void DeleteMediaOfType(int mediaTypeId, int userId = -1)

Id of the IMediaType

Optional id of the user deleting the media

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

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

Id of the IMediaType

Optional id of the user deleting the media

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

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

Id of the IMedia object to delete a version from

Id of the version to delete

Boolean indicating whether to delete versions prior to the versionId

Optional Id of the User deleting versions of a Media object

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

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

Id of the IMedia object to delete versions from

Latest version date

Optional Id of the User deleting versions of a Media object

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

public OperationResult EmptyRecycleBin(int userId = -1)

Optional Id of the User emptying the Recycle Bin

public async Task<OperationResult> EmptyRecycleBinAsync(Guid userId)

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

public IEnumerable<IMedia> GetAncestors(int id)

Id of the IMedia to retrieve ancestors for

An Enumerable list of IMedia objects

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

public IEnumerable<IMedia> GetAncestors(IMedia media)

IMedia to retrieve ancestors for

An Enumerable list of IMedia objects

Gets an IMedia object by its 'UniqueId'

public IMedia GetById(Guid key)

Guid key of the Media to retrieve

Gets an IMedia object by Id

public IMedia GetById(int id)

Id of the Media to retrieve

Gets an IMedia object by Id

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

Ids of the Media to retrieve

Gets an IMedia object by Id

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

Ids of the Media to retrieve

Gets a collection of IMedia objects by Level

public IEnumerable<IMedia>? GetByLevel(int level)

The level to retrieve Media from

An Enumerable list of IMedia objects

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

public IMedia GetMediaByPath(string mediaPath)

Path of the media item to retrieve (for example: /media/1024/koala_403x328.jpg)

public Stream GetMediaFileContentStream(string filepath)

public long GetMediaFileSize(string filepath)

Gets a collection of IMedia objects by Parent Id

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

Id of the Parent to retrieve Children from

Page number

Page size

An Enumerable list of IContent objects

Gets a collection of IMedia objects by Parent Id

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

Id of the Parent to retrieve Descendants from

Page number

Page size

An Enumerable list of IContent objects

Gets a collection of an IMedia objects, which resides in the Recycle Bin

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

An Enumerable list of IMedia objects

Gets paged documents of a content

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

The page number.

The page number.

The page size.

Total number of documents.

Search text filter.

Ordering infos.

Gets paged documents for specified content types

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

The page number.

The page number.

The page size.

Total number of documents.

Search text filter.

Ordering infos.

Gets the parent of the current media as an IMedia item.

public IMedia GetParent(int id)

Id of the IMedia to retrieve the parent from

Gets the parent of the current media as an IMedia item.

public IMedia GetParent(IMedia media)

IMedia to retrieve the parent from

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

public IEnumerable<IMedia> GetRootMedia()

An Enumerable list of IMedia objects

Gets a specific version of an IMedia item.

public IMedia GetVersion(int versionId)

Id of the version to retrieve

Gets a collection of an IMedia objects versions by Id

public IEnumerable<IMedia> GetVersions(int id)

An Enumerable list of IMedia objects

Checks whether an IMedia item has any children

public bool HasChildren(int id)

Id of the IMedia

True if the media has any children otherwise False

Moves an IMedia object to a new location

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

The IMedia to move

Id of the Media's new Parent

Id of the User moving the Media

Deletes an IMedia object by moving it to the Recycle Bin

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

The IMedia to delete

Id of the User deleting the Media

public bool RecycleBinSmells()

Saves a collection of IMedia objects

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

Collection of IMedia to save

Id of the User saving the Media

Saves a single IMedia object

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

The IMedia to save

Id of the User saving the Media

public void SetMediaFileContent(string filepath, Stream stream)

Sorts a collection of IMedia objects by updating the SortOrder according to the ordering of items in the passed in .

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

True if sorting succeeded, otherwise False

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4