feat(ads): Add getDescription to CS and SS ads (shaka-project#4526)

joeyparrish · Sep 29, 2022 · 7d2a170 · 7d2a170
1 parent c97768b
commit 7d2a170
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 0 deletions.
diff --git a/externs/ima.js b/externs/ima.js
@@ -170,6 +170,9 @@ google.ima.Ad = class {
 
   /** @return {string} */
   getTitle() {}
+
+  /** @return {string} */
+  getDescription() {}
 };
 
 
@@ -395,6 +398,9 @@ google.ima.dai.api.Ad = class {
 
   /** @return {string} */
   getTitle() {}
+
+  /** @return {string} */
+  getDescription() {}
 };
 
 

diff --git a/externs/shaka/ads.js b/externs/shaka/ads.js
@@ -232,4 +232,9 @@ shaka.extern.IAd = class {
    * @return {string}
    */
   getTitle() {}
+
+  /**
+   * @return {string}
+   */
+  getDescription() {}
 };
diff --git a/lib/ads/client_side_ad.js b/lib/ads/client_side_ad.js
@@ -244,6 +244,14 @@ shaka.ads.ClientSideAd = class {
     return this.ad_.getTitle();
   }
 
+  /**
+   * @override
+   * @export
+   */
+  getDescription() {
+    return this.ad_.getDescription();
+  }
+
   /**
    * @override
    * @export

diff --git a/lib/ads/server_side_ad.js b/lib/ads/server_side_ad.js
@@ -213,6 +213,14 @@ shaka.ads.ServerSideAd = class {
     return this.ad_.getTitle();
   }
 
+  /**
+   * @override
+   * @export
+   */
+  getDescription() {
+    return this.ad_.getDescription();
+  }
+
   /**
    * @override
    * @export

diff --git a/test/test/util/fake_ad.js b/test/test/util/fake_ad.js
@@ -37,6 +37,9 @@ shaka.test.FakeAd = class {
 
     /** @private {string} */
     this.title_ = 'Test Title';
+
+    /** @private {string} */
+    this.description_ = 'Test Description';
   }
 
   /**
@@ -201,6 +204,14 @@ shaka.test.FakeAd = class {
     return this.title_;
   }
 
+  /**
+   * @override
+   * @export
+   */
+  getDescription() {
+    return this.description_;
+  }
+
   /**
    * @override
    * @export