ItunesExtension (YARFRAW - Yet Another RSS Feed Reader Appender Writer API 0.93-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

yarfraw.generated.itunes.elements
Class ItunesExtension

java.lang.Object
  yarfraw.generated.itunes.elements.ItunesExtension

public class ItunesExtension
extends Object
extends Object

Java class for anonymous complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{http://www.itunes.com/dtds/podcast-1.0.dtd}category" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.itunes.com/dtds/podcast-1.0.dtd}keywords" minOccurs="0"/>
         <element ref="{http://www.itunes.com/dtds/podcast-1.0.dtd}subtitle" minOccurs="0"/>
         <element ref="{http://www.itunes.com/dtds/podcast-1.0.dtd}duration" minOccurs="0"/>
         <element ref="{http://www.itunes.com/dtds/podcast-1.0.dtd}summary" minOccurs="0"/>
         <element ref="{http://www.itunes.com/dtds/podcast-1.0.dtd}image" minOccurs="0"/>
         <element ref="{http://www.itunes.com/dtds/podcast-1.0.dtd}explicit" minOccurs="0"/>
         <element ref="{http://www.itunes.com/dtds/podcast-1.0.dtd}owner" minOccurs="0"/>
         <element ref="{http://www.itunes.com/dtds/podcast-1.0.dtd}author" minOccurs="0"/>
         <element ref="{http://www.itunes.com/dtds/podcast-1.0.dtd}block" minOccurs="0"/>
         <element ref="{http://www.itunes.com/dtds/podcast-1.0.dtd}new-feed-url" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary
`protected String`	`author`
`protected String`	`block`
`protected List<ItunesCategoryType>`	`category`
`protected String`	`duration`
`protected String`	`explicit`
`protected ItunesImageType`	`image`
`protected String`	`keywords`
`protected String`	`newFeedUrl`
`protected ItunesOwnerType`	`owner`
`protected String`	`subtitle`
`protected String`	`summary`

Constructor Summary
`ItunesExtension()`

Method Summary
`String`	`getAuthor()` The content of this tag is shown in the Artist column in iTunes.
`String`	`getBlock()` Use this inside a `<channel>` element to prevent the entire podcast from appearing in the iTunes Podcast directory.
`List<ItunesCategoryType>`	`getCategory()` There are two ways to browse podcast subject categories on iTunes: click Browse in the Quick Links box or click a selection in the Category box.
`String`	`getDuration()` The content of this tag is shown in the Time column in iTunes.
`String`	`getExplicit()` This tag should be used to indicate whether or not your podcast contains explicit material.
`ItunesImageType`	`getImage()` This tag specifies the artwork for your podcast.
`String`	`getKeywords()` This tag allows users to search on a maximum of 12 text keywords.
`String`	`getNewFeedUrl()` This tag allows you to change the URL where the podcast feed is located.
`ItunesOwnerType`	`getOwner()` Put the email address of the owner in a nested `<itunes:email>`element.
`String`	`getSubtitle()` The contents of this tag are shown in the Description column in iTunes.
`String`	`getSummary()` The contents of this tag are shown in a separate window that appears when the "circled i" in the Description column is clicked.
`void`	`setAuthor(String value)` Sets the value of the author property.
`void`	`setBlock(String value)` Sets the value of the block property.
`void`	`setDuration(String value)` Sets the value of the duration property.
`void`	`setExplicit(String value)` Sets the value of the explicit property.
`void`	`setImage(ItunesImageType value)` Sets the value of the image property.
`void`	`setKeywords(String value)` Sets the value of the keywords property.
`void`	`setNewFeedUrl(String value)` Sets the value of the newFeedUrl property.
`void`	`setOwner(ItunesOwnerType value)` Sets the value of the owner property.
`void`	`setSubtitle(String value)` Sets the value of the subtitle property.
`void`	`setSummary(String value)` Sets the value of the summary property.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

keywords

protected String keywords

subtitle

protected String subtitle

duration

protected String duration

summary

protected String summary

image

protected ItunesImageType image

explicit

protected String explicit

owner

protected ItunesOwnerType owner

author

protected String author

block

protected String block

newFeedUrl

protected String newFeedUrl

Constructor Detail

ItunesExtension

public ItunesExtension()

Method Detail

getCategory

public List<ItunesCategoryType> getCategory()

There are two ways to browse podcast subject categories on iTunes: click Browse in the Quick Links box or click a selection in the Category box. The former method leads to a text-based table, while the latter leads to pages that include the podcast art.

For placement within the older, text-based browse system, podcast feeds may list up to 3 category/subcategory pairs. (For example, "Music" counts as 1, as does "Business > Careers.") For placement within the newer browse system based on Category links, however, and for placement within the Top Podcasts lists that appear in the right column of most podcast pages, only the first category listed in the feed is used.

Categories and subcategories can be specified as follows. Use a top level <itunes:category> to specify the browse category, and a nested <itunes:category> to specify the browse subcategory. Choose from the existing categories and subcategories in iTunes. Be sure to properly escape ampersands. A complete list is included at the end of this document.

Note that a separate set of categories was active until July 2006, when it was replaced by the new set at the end of this document. During a transition period, most of the old categories and subcategories will be automatically mapped to corresponding ones within the new system. For example, if your podcast was listed under "Arts & Entertainment > Photography", it will now appear under "Arts > Visual Arts." However, 3 categories have been removed and do not have a similar replacement: "International", "Talk Radio", and "Public Radio". Those categories overlapped with others in the old system, making some podcasts difficult to discover. If one of these categories is listed as the first subject in your podcast feed, that category information will be ignored and the second category will be used to determine eligibility and placement in that feature page.

Examples:

Single category:

     <itunes:category text="Music" />

Category with ampersand:

     <itunes:category text="TV &amp; Film" />

Category with Subcategory:

     <itunes:category text="Society &amp; Culture">
                <itunes:category text="History" />
                </itunes:category>

Entry with multiple categories:

     <itunes:category text="Society &amp; Culture">
                <itunes:category text="History" />
                </itunes:category>
                <itunes:category text="Technology">
                <itunes:category text="Gadgets" />
 
                </itunes:category>

Gets the value of the category property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the category property.

For example, to add a new item, do as follows:

    getCategory().add(newItem);

Objects of the following type(s) are allowed in the list ItunesCategoryType

getKeywords

public String getKeywords()

This tag allows users to search on a maximum of 12 text keywords. Use commas to separate keywords.

Returns:: possible object is String

setKeywords

public void setKeywords(String value)

Sets the value of the keywords property.

Parameters:: value - allowed object is String

getSubtitle

public String getSubtitle()

The contents of this tag are shown in the Description column in iTunes. The subtitle displays best if it is only a few words long.

Returns:: possible object is String

setSubtitle

public void setSubtitle(String value)

Sets the value of the subtitle property.

Parameters:: value - allowed object is String

getDuration

public String getDuration()

The content of this tag is shown in the Time column in iTunes.

The tag can be formatted HH:MM:SS, H:MM:SS, MM:SS, or M:SS (H = hours, M = minutes, S = seconds). If an integer is provided (no colon present), the value is assumed to be in seconds. If one colon is present, the number to the left is assumed to be minutes, and the number to the right is assumed to be seconds. If more than two colons are present, the numbers furthest to the right are ignored.

Returns:: possible object is String

setDuration

public void setDuration(String value)

Sets the value of the duration property.

Parameters:: value - allowed object is String

getSummary

public String getSummary()

The contents of this tag are shown in a separate window that appears when the "circled i" in the Description column is clicked. It also appears on the iTunes page for your podcast. This field can be up to 4000 characters. If <itunes:summary> is not included, the contents of the tag are used.

Returns:: possible object is String

setSummary

public void setSummary(String value)

Sets the value of the summary property.

Parameters:: value - allowed object is String

getImage

public ItunesImageType getImage()

This tag specifies the artwork for your podcast. Put the URL to the image in the href attribute. iTunes prefers square .jpg images that are at least 300 x 300 pixels, which is different than what is specified for the standard RSS image tag.

iTunes supports images in JPEG and PNG formats. The URL must end in ".jpg" or ".png". If the itunes:image tag is not present, iTunes will use the contents of the RSS image tag.

If you change your podcast’s image, also change the file’s name. iTunes may not change the image if it checks your feed and the image URL is the same.

Spend some time developing an attractive, original image that represents your podcast well. Potential subscribers will see it on your podcast’s page and a much smaller version of the image in search results and feature placements. Make sure your design is effective in both sizes.

The itunes:image tag is not supported at the item level. It is possible to include art within individual episodes, but the art is included within the media file’s metadata, not in the RSS feed. To add artwork to an episode using iTunes, highlight the episode and select "Get Info" from the "File" menu. Click the Artwork tab. Then click "Add," navigate to and select an image file, and click "Choose."

Returns:: possible object is ItunesImageType

setImage

public void setImage(ItunesImageType value)

Sets the value of the image property.

Parameters:: value - allowed object is ItunesImageType

getExplicit

public String getExplicit()

This tag should be used to indicate whether or not your podcast contains explicit material. The three values for this tag are "yes", "no", and "clean".

If you populate this tag with "yes", an "explicit" parental advisory graphic will appear next to your podcast artwork on the iTunes Music Store, and in the Name column in iTunes. If the value is "clean", the parental advisory type is considered Clean, meaning that no explicit language or adult content is included anywhere in the episodes, and a "clean" graphic will appear. If the explicit tag is present and has any other value (e.g. "no") you see no indicator — blank is the default advisory type.

This tag contains information that will be used to contact the owner of the podcast for communication specifically about their podcast. It will not be publicly displayed.

Returns:: possible object is String

setExplicit

public void setExplicit(String value)

Sets the value of the explicit property.

Parameters:: value - allowed object is String

getOwner

public ItunesOwnerType getOwner()

Put the email address of the owner in a nested <itunes:email>element.

Put the name of the owner in a nested <itunes:name>element.

Returns:: possible object is ItunesOwnerType

setOwner

public void setOwner(ItunesOwnerType value)

Sets the value of the owner property.

Parameters:: value - allowed object is ItunesOwnerType

getAuthor

public String getAuthor()

The content of this tag is shown in the Artist column in iTunes. If the tag is not present, iTunes uses the contents of the <author> tag. If <itunes:author> is not present at the feed level, iTunes will use the contents of <managingEditor>.

Returns:: possible object is String

setAuthor

public void setAuthor(String value)

Sets the value of the author property.

Parameters:: value - allowed object is String

getBlock

public String getBlock()

Use this inside a <channel> element to prevent the entire podcast from appearing in the iTunes Podcast directory. Use this inside an <item> element to prevent that episode from appearing in the iTunes Podcast directory. For example, you may want a specific episode blocked from iTunes if its content might cause the feed to be removed from iTunes.

If this tag is present and set to "yes" (case insensitive), that means to block the feed or the episode. If the tag’s value is any other value, including empty string, it’s indicated as a signal to unblock the feed or episode. At the feed level, if there is no block tag, then the block status of the feed is left unchanged. At the episode level, if there is no block tag, it is the same as if a block=no were present.

Returns:: possible object is String

setBlock

public void setBlock(String value)

Sets the value of the block property.

Parameters:: value - allowed object is String

getNewFeedUrl

public String getNewFeedUrl()

This tag allows you to change the URL where the podcast feed is located. It is added at the <channel> level. The feed format is:

<itunes:new-feed-url>http://newlocation.com/example.rss</itunes:new-feed-url>

After adding the tag to your old feed, you should maintain the old feed for 48 hours before retiring it. At that point, iTunes will have updated the directory with the new feed URL. For more information, please see the "Changing Your Feed URL" section above.

Returns:: possible object is String

setNewFeedUrl

public void setNewFeedUrl(String value)

Sets the value of the newFeedUrl property.

Parameters:: value - allowed object is String