Class Podcast

Podcast subscription class

Podcast

Hierarchy (view full)

SharedMediaObject
- Podcast

Constructors

constructor

new Podcast(): Podcast
Returns Podcast
Inherited from SharedMediaObject.constructor

Properties

asJSON

asJSON: string

Gets the object as serialized JSON string. Or sets serialized JSON (to fill this object's metadata by the metadata included within the JSON)

customizeRules

customizeRules: boolean

State of '[x] Customize subscription rules' checkbox to override global podcast settings

delEpisodes

delEpisodes: boolean

State of '[x] Delete episodes older than' checkbox

delOnlyListened

delOnlyListened: boolean

State of '[x] Only if they have been listened to' checkbox

delRating

delRating: boolean

State of '[x] Only if rating less than' checkbox

delRatingValue

delRatingValue: number

Gets/Sets rating value corresponding to '[x] Only if rating less than' checkbox

deleted

deleted: boolean

Set to true after deletion so that 'change' event is called and item is removed from UI lists.

description

description: string

Gets/Sets description of this podcast subscription

dontNotify

dontNotify: boolean

Undocumented

downloadType

downloadType: number

Value correposning to '[x] On update, download [xxx][yyy]' dropdowns

DOWNLOAD_ALL = 0; DOWNLOAD_RECENT_1 = 1; DOWNLOAD_RECENT_2 = 2; DOWNLOAD_RECENT_5 = 3; DOWNLOAD_RECENT_10 = 4; DOWNLOAD_RECENT_20 = 5; DOWNLOAD_NOTHING = 6; DOWNLOAD_RECENT_1_DAY = 7; DOWNLOAD_RECENT_2_DAYS = 8; DOWNLOAD_RECENT_3_DAYS = 9; DOWNLOAD_RECENT_WEEK = 10; DOWNLOAD_RECENT_2_WEEK = 11; DOWNLOAD_RECENT_MONTH = 12; DOWNLOAD_OLDEST_1 = 13; DOWNLOAD_OLDEST_2 = 14; DOWNLOAD_OLDEST_5 = 15; DOWNLOAD_OLDEST_10 = 16; DOWNLOAD_OLDEST_20 = 17;

episodeAge

episodeAge: number

Value correposning to '[x] Delete episodes older than [xxx]' dropdown

generator

generator: string

Undocumented

id

id: number

Undocumented

idColl

idColl: number

Undocumented

isObservable

isObservable: boolean

Whether this object can be listened (e.g. for 'change' event)

isStatusBarSource

isStatusBarSource: boolean

Is source for status bar informations.

itemImageType

itemImageType: string

Undocumented

login

Gets/Sets login in case podcast feed is password protected

objectType

objectType: string

Gets the object type as string

overwriteTags

overwriteTags: boolean

Value correposning to '[x] On download, tag episodes based on data from podcast feed' checkbox

password

password: string

Gets/Sets password in case podcast feed is password protected

persistentID

persistentID: string

Gets persistent id of the object

podcastURL

podcastURL: string

Gets/Sets subscription feed URL link (link to RSS/XML podcast feed)

retainEpisodes

retainEpisodes: boolean

Value correposning to '[x] Always retain the [xxx]' checkbox

retainNumber

retainNumber: number

Gets/Sets number of episodes to be kept

showRemovedEpisodes

showRemovedEpisodes: boolean

Whether to show links to already removed episodes

statusInfo

statusInfo: Promise<any>

Undocumented

supportPin

supportPin: boolean

Whether object support pin to pinned list

title

title: string

Gets/Sets title of the podcast subscription.

Methods

addLink

addLink(linkType, linkInfo, link): Promise<any>
Add new external list associated with object.
Parameters
- linkType: string
  Type of a link
- linkInfo: string
  Link information (like release or releaseGroup for musicbrainz link)
- link: string
  Link string
Returns Promise<any>
Inherited from SharedMediaObject.addLink
- Defined in src/types/Native.ts:980

beginUpdate

beginUpdate(): void
Lock object to update state. Events are not called when in update state.

Returns void
Inherited from SharedMediaObject.beginUpdate
- Defined in src/types/Native.ts:276

checkUpdate

checkUpdate(interval): void
Updates the object every X ms when called periodically. Useful e.g. when filling lists. Can be used only in the update lock! (i.e. between beginUpdate/endUpdate)
Parameters
- interval: number
Returns void
Inherited from SharedMediaObject.checkUpdate
- Defined in src/types/Native.ts:288

commitAsync

commitAsync(): Promise<any>
Commits this podcast

Returns Promise<any>
- Defined in src/types/Native.ts:5672

doCut

doCut(data): Promise<any>
Parameters
- data: Base
Returns Promise<any>
Undocumented
Inherited from SharedMediaObject.doCut
- Defined in src/types/Native.ts:213

endUpdate

endUpdate(): boolean
Unlock object from update state. beginUpdate and endUpdate must be in pair. When endUpdate is called, change event is called.

Returns boolean
Inherited from SharedMediaObject.endUpdate
- Defined in src/types/Native.ts:282

getAllLinksList

getAllLinksList(): ExternalLinksList
Get all external object links (acoustID, musicbrainz, wikipedia etc.)

Returns ExternalLinksList
Inherited from SharedMediaObject.getAllLinksList
- Defined in src/types/Native.ts:953

getChannelDataAsync

getChannelDataAsync(): Promise<any>
Returns Promise<any>
Undocumented
- Defined in src/types/Native.ts:5693

getClassName

getClassName(): string
Gets class name of the object.

Returns string
Inherited from SharedMediaObject.getClassName
- Defined in src/types/Native.ts:198

getEpisodeList

getEpisodeList(onlyDownloaded, onlyUnplayed): Tracklist
Gets episodes of this podcast subscription, similar to getTracklist(), but can specify other params
Parameters
- onlyDownloaded: boolean
- onlyUnplayed: boolean
Returns Tracklist
as promise
Example
```
var trcklist = Podcast.getEpisodeList(true, false); <br>
trcklist.whenLoaded().then(function () {  <br>
    // all downloaded episodes in trcklist  <br>
});                                       <br>
```
- Defined in src/types/Native.ts:5667

getEpisodesCount

getEpisodesCount(infoType): number
Parameters
- infoType: string
Returns number
Undocumented
- Defined in src/types/Native.ts:5695

getLinksList

getLinksList(...params): ExternalLinksList
Get external link associated with the object. All link identifiers are (updated list is available in consts.js) : var LINK_MUSICBRAINZ = 'musicbrainz', LINK_ACOUSTID = 'acoustid', LINK_TVDB = 'tvdb', LINK_MAZE = 'maze', LINK_IMDB = 'imdb', LINK_WIKI = 'wiki', LINK_ECHOPRINT = 'echoprint', LINK_MOVIEDB = 'moviedb', LINK_DISCOGS = 'discogs';
Parameters
- Rest ...params: any[]
Returns ExternalLinksList
Inherited from SharedMediaObject.getLinksList
- Defined in src/types/Native.ts:971

getPersistentJSON

getPersistentJSON(): string
Returns string
Undocumented
Inherited from SharedMediaObject.getPersistentJSON
- Defined in src/types/Native.ts:214

getThumbAsync

getThumbAsync(...params): number
Returns link to cached image thumbnail of the nearest specified size
Parameters
- Rest ...params: any[]
Returns number
- Defined in src/types/Native.ts:5687

getTracklist

getTracklist(...params): Tracklist

Gets all tracks (episodes) of this podcast subscription

Parameters

Rest ...params: any[]

Returns Tracklist

as promise

Example

var trcklist = Podcast.getTracklist(); <br>
trcklist.whenLoaded().then(function () {  <br>
    // all tracks are loaded here          <br>
});                                       <br>

isMarked

isMarked(id): boolean
Parameters
- id: number
Returns boolean
Undocumented
Inherited from SharedMediaObject.isMarked
- Defined in src/types/Native.ts:212

isPinned

isPinned(): Promise<any>
Object is pinned in pinned list

Returns Promise<any>
Inherited from SharedMediaObject.isPinned
- Defined in src/types/Native.ts:940

locked

locked(func): void
Call defined method with locked data so user can access them.
Parameters
- func: (() => any)
  Method to call
  - - (): any
    - Returns any
Returns void
Inherited from SharedMediaObject.locked
- Defined in src/types/Native.ts:192

modifyAsync

modifyAsync(...params): Promise<any>
Call defined method with the item locked for modifications.
Parameters
- Rest ...params: any[]
Returns Promise<any>
Inherited from SharedMediaObject.modifyAsync
- Defined in src/types/Native.ts:262

notifyChanged

notifyChanged(...params): void
Notifies that the object was changed (e.g. to force visual update etc.)
Parameters
- Rest ...params: any[]
Returns void
Inherited from SharedMediaObject.notifyChanged
- Defined in src/types/Native.ts:308

removeLink

removeLink(...params): Promise<any>
Remove external link from object.
Parameters
- Rest ...params: any[]
Returns Promise<any>
Inherited from SharedMediaObject.removeLink
- Defined in src/types/Native.ts:989

runUpdate

runUpdate(): void
Runs update of this podcast

Returns void
- Defined in src/types/Native.ts:5692

setMarked

setMarked(id, value): void
Parameters
- id: number
- value: boolean
Returns void
Undocumented
Inherited from SharedMediaObject.setMarked
- Defined in src/types/Native.ts:211

setPinned

setPinned(pinned, collID): void
Set object is pinned in pinned list.
Parameters
- pinned: boolean
  Object is pinned
- collID: number
  ID of collection where object is pinned
Returns void
Inherited from SharedMediaObject.setPinned
- Defined in src/types/Native.ts:947

toString

toString(): string
Returns string
Undocumented
Overrides SharedMediaObject.toString
- Defined in src/types/Native.ts:5694

toUriString

toUriString(): string
Returns string
Undocumented
Inherited from SharedMediaObject.toUriString
- Defined in src/types/Native.ts:263

unsubscribeAsync

unsubscribeAsync(deleteTracks): Promise<any>
Unsubscribes this podcast
Parameters
- deleteTracks: boolean
  If true, also downloaded tracks will be deleted
Returns Promise<any>
- Defined in src/types/Native.ts:5678

updateStatus

updateStatus(): void
Returns void
Undocumented
Inherited from SharedMediaObject.updateStatus
- Defined in src/types/Native.ts:297

Events

event_change

event_change: ((changeType, ...additionalArgs) => void)

Event is called when object is somehow changed

See App.listen

Type declaration

- (changeType, ...additionalArgs): void
- Parameters
  - changeType: string
    additional change type (can have values like 'tracklist', 'deleted', 'title' or undefined)
  - Rest ...additionalArgs: any[]
  Returns void

Example

app.listen(object, 'change', (changeType) => {  });

event_destroying

event_destroying: (() => void)

Event is called when object is going to destroy

See App.listen

Type declaration

- (): void
- Returns void

event_statuschange

event_statuschange: (() => void)

Event is called when status info of the object is changed

See App.listen

Type declaration

- (): void
- Returns void

Class Podcast

Hierarchy (view full)

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Returns Podcast

Properties

asJSON

customizeRules

delEpisodes

delOnlyListened

delRating

delRatingValue

deleted

description

dontNotify

Undocumented

downloadType

episodeAge

generator

Undocumented

id

Undocumented

idColl

Undocumented

isObservable

isStatusBarSource

itemImageType

Undocumented

login

objectType

overwriteTags

password

persistentID

podcastURL

retainEpisodes

retainNumber

showRemovedEpisodes

statusInfo

Undocumented

supportPin

title

Methods

addLink

Parameters

Returns Promise<any>

beginUpdate

Returns void

checkUpdate

Parameters

Returns void

commitAsync

Returns Promise<any>

doCut

Parameters

Returns Promise<any>

Undocumented

endUpdate

Returns boolean

getAllLinksList

Returns ExternalLinksList

getChannelDataAsync

Returns Promise<any>

Undocumented

getClassName

Returns string

getEpisodeList

Parameters

Returns Tracklist

Example

getEpisodesCount

Parameters

Returns number

Undocumented

getLinksList

Parameters