Class adobeDPS-ArticleMetaData
- Platforms:
- iOS, Android
This class represents the meta data of the article.
Constructor
adobeDPS-ArticleMetaData(artTitle:string, artDesc:string, artAuth:string, artKicker:string, previewURL:string, isHSwipeOnly:bool, hasArtFreePreview:bool, artName:string)
[inner]
Create an Article meta data object.
Fields
Field | Defined By | |
---|---|---|
title
: string
The title as provided in the Article meta data
|
ArticleMetaData
|
|
description
: string
The description of article as provided in the Article meta data
|
ArticleMetaData
|
|
author
: string
The author of the article as provided in the Article meta data
|
ArticleMetaData
|
|
kicker
: string
The kicker of the article as provided in the Article meta data
|
ArticleMetaData
|
|
articleTOCPreviewURL
: string
The TOC Preview URL of the article
|
ArticleMetaData
|
|
isHorizontalSwipeOnly
: bool
A boolean value indicating whether the article has only a horizontal swipe enabled.
|
ArticleMetaData
|
|
hasFreePreview
: bool
A boolean value indicating whether a Free article preview is available.
|
ArticleMetaData
|
|
name
: string
The article name as provided in the Article meta data
|
ArticleMetaData
|
Class Detail
adobeDPS-ArticleMetaData(artTitle:string, artDesc:string, artAuth:string, artKicker:string, previewURL:string, isHSwipeOnly:bool, hasArtFreePreview:bool, artName:string)
[inner]
Create an Article meta data object.
Parameters | ||
---|---|---|
artTitle | string | The title of the article |
artDesc | string | The description of the article |
artAuth | string | The author of the article |
artKicker | string | The kicker of the article |
previewURL | string | the TOC Preview URL of the article |
isHSwipeOnly | bool | if only horizontal swipe is enabled |
hasArtFreePreview | bool | If the article free preview is present |
artName | string | The name of the article |
Field Details
title
: string
The title as provided in the Article meta data
- Platforms:
- iOS, Android
description
: string
The description of article as provided in the Article meta data
- Platforms:
- iOS, Android
author
: string
The author of the article as provided in the Article meta data
- Platforms:
- iOS, Android
kicker
: string
The kicker of the article as provided in the Article meta data
- Platforms:
- iOS, Android
articleTOCPreviewURL
: string
The TOC Preview URL of the article
- Platforms:
- iOS, Android
isHorizontalSwipeOnly
: bool
A boolean value indicating whether the article has only a horizontal swipe enabled.
- Platforms:
- iOS, Android
hasFreePreview
: bool
A boolean value indicating whether a Free article preview is available. For open
articles, it is always true.
- Platforms:
- iOS
name
: string
The article name as provided in the Article meta data
- Platforms:
- iOS
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:39 GMT-0700 (PDT)
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:39 GMT-0700 (PDT)