-
Notifications
You must be signed in to change notification settings - Fork 27
Technical Specification Document
This document will walk you through the technical aspects of the plugin and how the plugin flow works. If the plugin use some external apis or references , they are also mentioned here.
- Angular Js
- Buildfire APIs
Plugin is divided into three main sections:
- Content
- Design
- Widget
In this section user can add , edit or delete Carousel images and WYSIWYG text. It also provides ability for user to choose and enter channel feed url or single video url and validate it accordingly.
In this section user can have control over look and feel of their app in widget section. They can change list layout, set or remove background images for video list page and single video page as well.
This section reflects the actual data from content section. So if user has chosen channel feed, then it will show list of videos, if user has chosen single video, it will show single video in youtube embedded video player and details corresponding to it. All the changes made in content and design section reflects live on widget section. In case of channel url, videos are lazyloaded on scroll.
The plugin uses Buildfire Datastore Apis for saving and retrieving data.
For fetching youtube data, plugin consumes Buildfire proxy (http://proxy.buildfire.com/) APIs :
-
/video: Post api call to fetch a youtube video details for given video id. -
/videos: Post api call to fetch a paginated list of youtube videos for given playlist id, page token and count limit