Interface IMediaContentService
Summary description for IMediaContentService.
Namespace: ImageVault.Common.Services
Assembly: ImageVault.Common.dll
Syntax
public interface IMediaContentService : IServiceMethods
CreateZipArchive(IEnumerable<Int32>, Int32)
Creates a zip archive for the supplied items
Declaration
string CreateZipArchive(IEnumerable<int> mediaItemIds, int mediaFormatId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<System.Int32> | mediaItemIds | The id of items to include in the archive |
| System.Int32 | mediaFormatId | The id of the mediaFormatId to get them in |
Returns
| Type | Description |
|---|---|
| System.String | The key to use to retrieve the archive |
DeleteAuxiliaryContent(Int32, String)
Delete auxiliary content
Declaration
void DeleteAuxiliaryContent(int versionId, string key)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | versionId | |
| System.String | key |
ListAuxiliaryContent(Int32, Uri)
List auxiliary content for the supplied version
Declaration
IList<AuxiliaryContentInfo> ListAuxiliaryContent(int versionId, Uri uriBase)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | versionId | |
| System.Uri | uriBase |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IList<AuxiliaryContentInfo> |
PublishMedia(String, PublishInfo)
Publishes the supplied media using the identifier and returns the published key
Declaration
string PublishMedia(string mediaContentReferenceId, PublishInfo publishInfo)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | mediaContentReferenceId | The id of the media content reference to publish |
| PublishInfo | publishInfo | The PublishInfo that describes the publication |
Returns
| Type | Description |
|---|---|
| System.String | The id of the publishedMediaContentReference |
PublishMedia(String, String)
Publishes the supplied media using the identifier and returns the published key
Declaration
[Obsolete("Use string PublishMedia(string mediaContentReferenceId, PublishInfo publishInfo) instead")]
string PublishMedia(string mediaContentReferenceId, string publishIdentifier)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | mediaContentReferenceId | The id of the media content reference to publish |
| System.String | publishIdentifier | The publish identifier to use |
Returns
| Type | Description |
|---|---|
| System.String | The id of the publishedMediaContentReference |
StoreAuxiliaryContent(Int32, AuxiliaryContent)
Stores AuxiliaryContent for a version
Declaration
void StoreAuxiliaryContent(int versionId, AuxiliaryContent content)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | versionId | |
| AuxiliaryContent | content |
StoreContentAsNewVersion(String, String, String, Int32)
Stores the uploaded content as a new version for the supplied media item
Declaration
MediaVersion StoreContentAsNewVersion(string uploadFileId, string filename, string contentType, int mediaItemId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | uploadFileId | The id of the file that was uploaded |
| System.String | filename | The original filename |
| System.String | contentType | The contentType of the file or pass null to let the content type be determined by ImageVault |
| System.Int32 | mediaItemId | The media item id that the uploaded content should be a new version for |
Returns
| Type | Description |
|---|---|
| MediaVersion | The MediaVersion that was created |
Remarks
The new version will not be marked as current version
StoreContentInVault(String, String, String, Int32)
Finalizes the upload by indicating that the uploaded file is completed and are ready to be analyzed
Declaration
MediaItem StoreContentInVault(string uploadFileId, string filename, string contentType, int vaultId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | uploadFileId | The id of the file that was uploaded |
| System.String | filename | The original filename |
| System.String | contentType | The contentType of the file or pass null to let the content type be determined by ImageVault |
| System.Int32 | vaultId | The id of the vault to store it in. |
Returns
| Type | Description |
|---|---|
| MediaItem | The MediaItem for the uploaded item |
Exceptions
| Type | Condition |
|---|---|
| System.Security.Authentication.AuthenticationException | If you need to be authenticated to create media items. |