OpenVeo Publish AngularJS back end

API Docs for: 8.0.0
Show:

publishService

Defined in: app/client/admin/js/ovPub/PublishService.js:5
Module: ov.publish

Summary

Defines a publish service to manage medias, categories and properties.

Methods

addMedia

Defined in app/client/admin/js/ovPub/PublishService.js:344

Syntax

addMedia

(
  • Information
)
Promise

Summary

Adds a media.

Parameters:

  • Information Object

    about the media

Returns:

Promise:

An HTTP promise resolving when media has been added

cacheClear

Defined in app/client/admin/js/ovPub/PublishService.js:305

Syntax

cacheClear

(
  • [type]
)

Summary

Clears a publish service cache.

Parameters:

  • [type] String optional

    The cache element to clear (properties, categories or editor), null to clear all caches

getCategoriesByKey

Defined in app/client/admin/js/ovPub/PublishService.js:192

Syntax

getCategoriesByKey

() Object

Summary

Gets list of categories indexed by keys.

Returns:

Object:

The list of categories

getCategoriesOptions

Defined in app/client/admin/js/ovPub/PublishService.js:182

Syntax

getCategoriesOptions

() Array

Summary

Gets the list of categories formatted for an HTMLSelect element.

Returns:

Array:

The list of categories

getConfiguration

Defined in app/client/admin/js/ovPub/PublishService.js:334

Syntax

getConfiguration

() Promise

Summary

Retrieves publish plugin configuration.

Returns:

Promise:

The HTTP promise

getPlatforms

Defined in app/client/admin/js/ovPub/PublishService.js:110

Syntax

getPlatforms

() Promise

Summary

Gets the list of available platforms.

Returns:

Promise:

The HTTP promise

getProperties

Defined in app/client/admin/js/ovPub/PublishService.js:79

Syntax

getProperties

() Promise

Summary

Gets list of properties.

Returns:

Promise:

The HTTP promise

getTaxonomyCategory

Defined in app/client/admin/js/ovPub/PublishService.js:172

Syntax

getTaxonomyCategory

() Object

Summary

Gets the taxonomy "categories".

Returns:

Object:

The taxonomy

loadMedia

Defined in app/client/admin/js/ovPub/PublishService.js:202

Syntax

loadMedia

(
  • id
)
Promise

Summary

Loads a media by its id.

Parameters:

Returns:

Promise:

The HTTP promise

loadPlatforms

Defined in app/client/admin/js/ovPub/PublishService.js:89

Syntax

loadPlatforms

() Promise

Summary

Loads the list of available media platforms from server.

Returns:

Promise:

The promise used to retrieve platforms from server

loadProperties

Defined in app/client/admin/js/ovPub/PublishService.js:58

Syntax

loadProperties

() Promise

Summary

Loads all properties from server.

Returns:

Promise:

The HTTP promise

loadTaxonomyCategory

Defined in app/client/admin/js/ovPub/PublishService.js:133

Syntax

loadTaxonomyCategory

() Promise

Summary

Loads taxonomy "categories".

Returns:

Promise:

The HTTP promise

publishMedia

Defined in app/client/admin/js/ovPub/PublishService.js:34

Syntax

publishMedia

(
  • id
)
Promise

Summary

Publishes the given media.

Parameters:

  • id String

    The id of the media to publish

Returns:

Promise:

The HTTP promise

removeChapters

Defined in app/client/admin/js/ovPub/PublishService.js:293

Syntax

removeChapters

(
  • id
  • chapterIds
)
HttpPromise

Summary

Removes chapters from media.

Parameters:

  • id String

    The media id

  • chapterIds Array

    The list of chapter ids to remove

Returns:

HttpPromise:

The HTTP promise

removeTags

Defined in app/client/admin/js/ovPub/PublishService.js:281

Syntax

removeTags

(
  • id
  • tagIds
)
Promise

Summary

Remove tags from media.

Parameters:

  • id String

    The media id

  • tagIds Array

    The list of tag ids to remove

Returns:

Promise:

The HTTP promise

retryMedia

Defined in app/client/admin/js/ovPub/PublishService.js:20

Syntax

retryMedia

(
  • id
)
Promise

Summary

Retries a media.

If a media is on error, the upload / publication process has stopped and can be retried.

Parameters:

  • id String

    The id of the media to retry

Returns:

Promise:

The HTTP promise

saveMediasSettings

Defined in app/client/admin/js/ovPub/PublishService.js:223

Syntax

saveMediasSettings

(
  • data
)
HttpPromise

Summary

Saves medias settings.

Parameters:

  • data Object

    The medias settings

Returns:

HttpPromise:

The HTTP promise

saveTlsSettings

Defined in app/client/admin/js/ovPub/PublishService.js:234

Syntax

saveTlsSettings

(
  • data
)
HttpPromise

Summary

Saves TLS settings.

Parameters:

  • data Object

    The TLS settings

Returns:

HttpPromise:

The HTTP promise

startMediaUpload

Defined in app/client/admin/js/ovPub/PublishService.js:120

Syntax

startMediaUpload

(
  • id
  • platform
)
Promise

Summary

Asks server to start uploading a media waiting for manual upload.

Parameters:

  • id String

    The id of the media to start uploading

  • platform String

    The media platform to upload to

Returns:

Promise:

The HTTP promise

unpublishMedia

Defined in app/client/admin/js/ovPub/PublishService.js:46

Syntax

unpublishMedia

(
  • id
)
Promise

Summary

Unpublishes the given media.

Parameters:

  • id String

    The id of the media to unpublish

Returns:

Promise:

The HTTP promise

updateChapter

Defined in app/client/admin/js/ovPub/PublishService.js:245

Syntax

updateChapter

(
  • id
  • chapter
)
HttpPromise

Summary

Updates a chapter associated to the specified media.

Parameters:

  • id String

    The media id

  • chapter Object

    Information about the chapter

    • [id] String optional

      The chapter id

    • [value] Number optional

      The chapter time in milliseconds

    • [name] String optional

      The chapter name

    • [description] String optional

      The chapter description

Returns:

HttpPromise:

The HTTP promise

updateMedia

Defined in app/client/admin/js/ovPub/PublishService.js:363

Syntax

updateMedia

(
  • Information
)
Promise

Summary

Update a media

Parameters:

  • Information Object

    about the media

Returns:

Promise:

An HTTP promise resolving when media has been updated

updateTag

Defined in app/client/admin/js/ovPub/PublishService.js:261

Syntax

updateTag

(
  • id
  • file
  • tag
)
Promise

Summary

Updates a tag associated to the specified media.

Parameters:

  • id String

    The media id

  • file Object

    The file to upload

  • tag Object

    Information about the tag

    • [id] String optional

      The tag id

    • [value] Number optional

      The tag time in milliseconds

    • [name] String optional

      The tag name

    • [description] String optional

      The tag description

Returns:

Promise:

The HTTP promise