Attention: Favorite Controller already works with v6 prefix. Please checkout General information on how to use our APIs
You can collect your favorite mediacontainers into collections. Those collections are technically mediacontainers of type “privatecollection” and subtype “favorite”. By default, you have one inside the client and one in every mediahub. Or again, to be technically correct, you have one favorite collection per clientId.
But, AdmiralCloud platform allows it to create more than one favorite collection, by just creating more mediacontainers of type “privatecollection” and subtype “favorite”. You have to use the mediaContainerId of the new collection, if you want to add mediacontainers as favorite to that collection.
Creating Favorites for external Mediahub
Use the same calls as below and make sure you send the publicAreaId and the link of the mediahub with every API request payload. The link is just the unique string identifier of your mediahub.
Reference
Favorite find
Returns all favorites for the current clientId. You can use a dedicated privateCollectionId for custom collections inside the AC Client app. For favorites in mediahubs, you must sent the publicAreaId and the link of the mediahub.
| Field | Type | Required | Description |
|---|
| link | string | ✗ | Required if you want to create favorites for a mediahub |
| privateCollectionId | integer | ✗ | The actual mediaContainerId/publicAreaId of the favorites collection. In combination with the clientId you can use multiple different favorite collections (private collections) |
| Field | Type | Description |
|---|
| ids | array | mediaContainerIds of favorites |
| privateCollectionId | integer | The actual mediaContainerId/publicAreaId of the favorites collection. In combination with the clientId you can use multiple different favorite collections (private collections) |
Favorite create
Creates a new favorite. You can use a dedicated privateCollectionId for custom collections inside the AC Client app. For favorites in mediahubs, you must sent the publicAreaId and the link of the mediahub.
| Field | Type | Required | Description |
|---|
| link | string | ✗ | Required if you want to create favorites for a mediahub |
| mediaContainerId | integer | ✓ | MediaContainerId you want to add as favorite. |
| privateCollectionId | integer | ✗ | The actual mediaContainerId/publicAreaId of the favorites collection. In combination with the clientId you can use multiple different favorite collections (private collections) |
| Field | Type | Description |
|---|
| ids | array | mediaContainerIds of favorites |
| privateCollectionId | integer | The actual mediaContainerId/publicAreaId of the favorites collection. In combination with the clientId you can use multiple different favorite collections (private collections) |
Favorite destroy
Deletes a favorite from your collection. You can use a dedicated privateCollectionId for custom collections inside the AC Client app. For favorites in mediahubs, you must sent the publicAreaId and the link of the mediahub.
| Field | Type | Required | Description |
|---|
| link | string | ✗ | Required if you want to create favorites for a mediahub |
| mediaContainerId | integer | ✓ | MediaContainerId you want to remove as favorite. |
| privateCollectionId | integer | ✗ | The actual mediaContainerId/publicAreaId of the favorites collection. In combination with the clientId you can use multiple different favorite collections (private collections) |
| Field | Type | Description |
|---|
| ids | array | mediaContainerIds of favorites |
| privateCollectionId | integer | The actual mediaContainerId/publicAreaId of the favorites collection. In combination with the clientId you can use multiple different favorite collections (private collections) |