Media In-Process API Service

Ben Tiedt — Tue, 19 Nov 2019 20:04:00 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:04:00

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IMedia>() and is defined in Telligent.Evolution.MediaGalleries.dll

Events

Events.AfterCreate

Handler

void MediaAfterCreateEventHandler([[MediaAfterCreateEventArgs In-Process API Event Argument|MediaAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void MediaAfterDeleteEventHandler([[MediaAfterDeleteEventArgs In-Process API Event Argument|MediaAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void MediaAfterUpdateEventHandler([[MediaAfterUpdateEventArgs In-Process API Event Argument|MediaAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void MediaBeforeCreateEventHandler([[MediaBeforeCreateEventArgs In-Process API Event Argument|MediaBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void MediaBeforeDeleteEventHandler([[MediaBeforeDeleteEventArgs In-Process API Event Argument|MediaBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void MediaBeforeUpdateEventHandler([[MediaBeforeUpdateEventArgs In-Process API Event Argument|MediaBeforeUpdateEventArgs]] e);

Events.Download

Handler

void MediaDownloadEventHandler([[MediaDownloadEventArgs In-Process API Event Argument|MediaDownloadEventArgs]] e);

Events.Render

Handler

void MediaRenderEventHandler([[MediaRenderEventArgs In-Process API Event Argument|MediaRenderEventArgs]] e);

Properties

Name	Type	Description	Default	Options
ContentTypeId	`Guid`	Media content type identifier

Methods

Media Create(int mediaGalleryId, string name, string contentType, string fileName, MediaCreateOptions options = null);

Creates a new media post

Parameters

Name	Type	Description	Required
mediaGalleryId	`int`	Media gallery Id	Required
name	`string`	Name	Required
contentType	`string`	The MIME content type of the attachment	Required
fileName	`string`	File name	Required
options	`[[MediaCreateOptions In-Process API Supplementary Type\|MediaCreateOptions]]`	Optional parameter names are: Description, FileData, FileStream, FileUploadContext, FileUrl, Tags, IsFeatured, FeaturedImage, ExtendedAttributes	Optional

Return Type

[[Media In-Process API Supplementary Type|Media]]

AdditionalInfo Delete(int fileId);

Deletes a media gallery post

Parameters

Name	Type	Description	Required	Default	Options
fileId	`int`	File Id	Required

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

Media Get(int mediaGalleryId, int fileId);

Gets a media gallery post

Parameters

Name	Type	Description	Required	Default	Options
mediaGalleryId	`int`	Media gallery Id	Required
fileId	`int`	File Id	Required

Return Type

[[Media In-Process API Supplementary Type|Media]]

Media Get(int fileId);

Gets a media gallery post

Parameters

Name	Type	Description	Required	Default	Options
fileId	`int`	File Id	Required

Return Type

[[Media In-Process API Supplementary Type|Media]]

Media Get(Guid contentId);

Gets a media gallery post

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required

Return Type

[[Media In-Process API Supplementary Type|Media]]

PagedList<Media> List(MediaListOptions options = null);

Lists media gallery posts

Parameters

Name	Type	Description	Required	Default	Options
options	`[[MediaListOptions In-Process API Supplementary Type\|MediaListOptions]]`	Optional parameter names are: GalleryId, GalleryIds, GroupId, IncludeSubGroups, IncludeUnpublished, ContentIds, PageSize, PageIndex, SortBy, SortOrder	Optional

Return Type

[[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[Media In-Process API Supplementary Type|Media]]>

Media Preview(int mediaGalleryId, string name, string contentType, string fileName, MediaCreateOptions options = null);

Previews a media gallery post

Parameters

Name	Type	Description	Required
mediaGalleryId	`int`	Media gallery Id	Required
name	`string`	Name	Required
contentType	`string`	The MIME content type of the attachment	Required
fileName	`string`	File name	Required
options	`[[MediaCreateOptions In-Process API Supplementary Type\|MediaCreateOptions]]`	Optional parameter names are: Description, FileData, FileStream, FileUploadContext, FileUrl, Tags, IsFeatured, FeaturedImage, ExtendedAttributes	Optional

Return Type

[[Media In-Process API Supplementary Type|Media]]

Media Preview(int mediaGalleryId, int fileId, MediaUpdateOptions options = null);

Previews a media gallery post

Parameters

Name	Type	Description	Required
mediaGalleryId	`int`	Media gallery Id	Required
fileId	`int`	File Id	Required
options	`[[MediaUpdateOptions In-Process API Supplementary Type\|MediaUpdateOptions]]`	Optional parameter names are: Name, Description, ContentType, FileName, FileData, FileStream, FileUploadContext, FileUrl, Tags, IsFeatured, FeaturedImage, ExtendedAttributes	Optional

Return Type

[[Media In-Process API Supplementary Type|Media]]

Media Update(int mediaGalleryId, int fileId, MediaUpdateOptions options = null);

Updates a media post

Parameters

Name	Type	Description	Required
mediaGalleryId	`int`	Media gallery Id	Required
fileId	`int`	File Id	Required
options	`[[MediaUpdateOptions In-Process API Supplementary Type\|MediaUpdateOptions]]`	Optional parameter names are: Name, Description, ContentType, FileName, FileData, FileStream, FileUploadContext, FileUrl, Tags, IsFeatured, FeaturedImage, ExtendedAttributes	Optional

Return Type

[[Media In-Process API Supplementary Type|Media]]