Video Apps

6min

View Item
When the user needs to be taken to the detail/view page of a video content. The app should handle the edge cases. For example-
Invalid item id.
If the user is not allowed to go to the videos detail page (maybe because the user is not logged-in).
Properties
Key
Value
Description
actionType
VIEW_ITEM
Type of action to be performed.
item
﻿Item﻿ 
the object of the item which holds itemID, Name. It is similar to an item sent via View Item﻿  event or via CMS
Code Example
JS
TS
Java
Kotlin
ObjectiveC
Swift
Dart
function onCooeeCTAListener(payload) {
    if (!payload) {
        return;
    }

    if (payload.get("actionType") == "VIEW_ITEM") {
        const item =  payload.get("item");
        // Show given item to the user
    }
}
function onCooeeCTAListener(payload) {
    if (!payload) {
        return;
    }

    if (payload.get("actionType") == "VIEW_ITEM") {
        const item =  payload.get("item");
        // Show given item to the user
    }
}
﻿
Play Item
When a particular video needs to be played. Users should be first taken to the view page of the content (if available). App should handle edge cases. For example-
The user is allowed to play the content.
Wrong content/item id.
Properties
Key
Value
Description
actionType
PLAY_ITEM
Type of action to be performed.
item
﻿Item﻿ 
the object of the item which holds itemID, Name. It is similar to an item sent via View Item﻿  event or via CMS
time
Number
Seconds from where video should start 
Code Example
JS
TS
Java
Kotlin
ObjectiveC
Swift
Dart
function onCooeeCTAListener(payload) {
    if (!payload) {
        return;
    }

    if (payload.get("actionType") == "PLAY_ITEM") {
        const item =  payload.get("item");
        const seconds =  payload.get("time");
        // Play given item for user starting from given seconds.
    }
}
function onCooeeCTAListener(payload) {
    if (!payload) {
        return;
    }

    if (payload.get("actionType") == "PLAY_ITEM") {
        const item =  payload.get("item");
        const seconds =  payload.get("time");
        // Play given item for user starting from given seconds.
    }
}
﻿
﻿

Key	Value	Description
actionType	VIEW_ITEM	Type of action to be performed.
item	Item	the object of the item which holds itemID, Name. It is similar to an item sent via View Item event or via CMS

Key	Value	Description
actionType	PLAY_ITEM	Type of action to be performed.
item	Item	the object of the item which holds itemID, Name. It is similar to an item sent via View Item event or via CMS
time	Number	Seconds from where video should start

Updated 25 Mar 2024

Did this page help you?

Retail/Ecommerce Apps

System Events