DOCSEARCHbyAlgolia
Submit Docs

DIGIDECK Developer Documentation

website·Indexed 34 days ago

https://developer.sportsdigita.com/

Documentation for DIGIDECK, a cloud-based interactive presentation platform by Sportsdigita. Includes the Digideck CORE API for interacting with presentation state, services for video playback (Video.js), navigation, and UI management, as well as the DIGI AI layer and CLI tools for component development.

Tokens
28K
Snippets
234
Records
267
Agent score
50%

What's inside DIGIDECK

  1. Overview of DigideckCORE system objects

    DigideckCORE exposes several core objects and classes to manage the state and behavior of the Digideck system. Key objects include:

    • Component: The base class for all Digideck components.
    • Deck: Provides access to the Digideck Deck object.
    • Data Store: A singleton class used to create, update, and listen to data changes in memory.
    • Digideck: Provides access to the primary Digideck object.
    • Modal Class: The base class for the Modal Service.
    • Presentation: Provides access to the Digideck Presentation object.
    • Slide: Provides access to the Digideck Slide object.

  2. Overview of the DIGI AI Layer capabilities

    DIGI is the AI layer powering the DIGIDECK platform. It consists of four primary capabilities:

    • DIGI Connect: Integrates DIGIDECK into existing tools (e.g., Claude, ChatGPT, Microsoft Copilot, Salesforce, HubSpot).
    • DIGI Present: A conversational AI for assembling and modifying decks via natural-language prompts using the Master Deck Library.
    • DIGI Builder: A structured, persona-driven guided experience for tailoring opportunities to specific buyers based on industry and use case.
    • DIGI Insights: An intelligence layer that analyzes presentation engagement to provide buying signals and actionable pipeline recommendations.

  3. Introduction to the DIGIDECK Platform

    DIGIDECK by Sportsdigita is a cloud-based, interactive presentation platform designed for sports organizations, enterprise businesses, and franchises. It is used to create and deliver visual, personalized, and data-driven sales and marketing presentations.

  4. Overview of Brand Kit Key Service

    The Brand Kit Key Service manages the caching of brand kit key/value pairs into an in-memory dictionary. The presentation or deck is responsible for caching the brand kit dictionary in a script tag during the render process. This service allows developers to retrieve the full dictionary, get specific values, update values, and convert between keys and values within component options.

  5. Develop components using Digideck CORE

    Components are the primary building blocks for slides, decks, and presentations, featuring encapsulated functionality and styling. Developers use the Digideck CORE API to give components access to the state and behavior of Decks and Presentations via the digideckCore API object.

  6. Access and use the Digideck CORE API

    Digideck CORE is a global API object available to all components. It allows developers to interact with Digideck Presentations and Decks by providing access to their state and behavior, which can be used to extend component functionality. The API is accessed via the global variable digideckCore and is organized into three main sections: Objects (data access), Services (behavior and state), and Utilities (helper functions).
    // Access the global Digideck CORE object
console.log(digideckCore);

  8. Unsubscribe from viewer prompt events

    To stop listening to viewer prompt events, use the corresponding off methods. You must pass the original reference to the callback function used during subscription to successfully unsubscribe.

    • offShowViewerPrompt(callback): Unsubscribes from the showViewerPrompt event.
    • offViewerPromptSubmit(callback): Unsubscribes from the viewerDataFormSubmit event.
    • offViewerPromptClose(callback): Unsubscribes from the closeViewerPrompt event.
    • offViewerPromptSkip(callback): Unsubscribes from the viewerDataFormSkipped event.
    // Define the callback
const myCallback = () => { console.log('Prompt closed'); };

// Subscribe
digideckCore.viewerPromptService.onViewerPromptClose(myCallback);

// Unsubscribe
digideckCore.viewerPromptService.offViewerPromptClose(myCallback);

  10. Implement the onInit lifecycle hook

    The onInit hook is invoked each time the custom element is appended into a document-connected element. It is used for initial component setup.
    constructor() {
  super();
}

onInit() {
  this.setupComponentHTML();
}

  11. Analyze presentation engagement with DIGI Insights

    DIGI Insights transforms presentation data into buying signals. It tracks who engaged with a deck and which sections they spent time on. Users can query the intelligence layer in plain language to identify high-intent leads (e.g., "who's hot in my pipeline this week?") and receive ranked answers with supporting reasoning.

  12. Set up and run the DIGIDECK Test Harness for local development

    The DIGIDECK Test Harness allows for local development of components using the ddcomponents CLI. To get started, ensure you have followed the general getting started instructions and installed localhost SSL certificates.

    Note that SSL certificates are not supported in Mozilla Firefox; use Chrome, Edge, or Safari. If using Chrome 142 or above, you must disable the flag chrome://flags/#local-network-access-check to avoid CORS errors when making localhost requests from the presentation layer.

    # 1. Install localhost SSL certificates
# On macOS/Linux (uses Homebrew)
ddcomp install

# On Windows (requires mkcert via chocolatey first)
choco install mkcert

# 2. Build, serve, and open the Test Harness
npm start
# OR
ddcomp serve