ProtocolRSS/dev.patbeagan.protocolrss.core/Channel

Channel

data class Channel( var title: String = DefaultString, var link: URL = URL("https://example.com"), var description: String = DefaultString, var categories: List<Category>? = null, var cloud: Cloud? = null, var copyright: String? = null, var docs: String? = null, var generator: String? = null, var image: Image? = null, var items: List<Item>? = null, var language: String? = null, var lastBuildDate: String? = null, var managingEditor: String? = null, var pubDate: String? = null, var rating: String? = null, var skipDays: SkipDays? = null, var skipHours: SkipHours? = null, var textInput: TextInput? = null, var ttl: Int? = null, var webMaster: String? = null)

Constructors

fun Channel( title: String = DefaultString, link: URL = URL("https://example.com"), description: String = DefaultString, categories: List<Category>? = null, cloud: Cloud? = null, copyright: String? = null, docs: String? = null, generator: String? = null, image: Image? = null, items: List<Item>? = null, language: String? = null, lastBuildDate: String? = null, managingEditor: String? = null, pubDate: String? = null, rating: String? = null, skipDays: SkipDays? = null, skipHours: SkipHours? = null, textInput: TextInput? = null, ttl: Int? = null, webMaster: String? = null)

Properties

var categories: List<Category>? = null

Specify one or more categories that the channel belongs to. Follows the same rules as the -level category element. More info.

var cloud: Cloud? = null

Allows processes to register with a cloud to be notified of updates to the channel, implementing a lightweight publish-subscribe protocol for RSS feeds. More info here.

var copyright: String? = null

Copyright notice for content in the channel.

var description: String

Phrase or sentence describing the channel.

var docs: String? = null

A URL that points to the documentation for the format used in the RSS file. It's probably a pointer to this page. It's for people who might stumble across an RSS file on a Web server 25 years from now and wonder what it is.

var generator: String? = null

A string indicating the program used to generate the channel.

var image: Image? = null

Specifies a GIF, JPEG or PNG image that can be displayed with the channel. More info here.

var items: List<Item>? = null

var language: String? = null

The language the channel is written in. This allows aggregators to group all Italian language sites, for example, on a single page. A list of allowable values for this element, as provided by Netscape, is here. You may also use values defined by the W3C.

var lastBuildDate: String? = null

The last time the content of the channel changed.

The URL to the HTML website corresponding to the channel.

var managingEditor: String? = null

Email address for person responsible for editorial content.

var pubDate: String? = null

The publication date for the content in the channel. For example, the New York Times publishes on a daily basis, the publication date flips once every 24 hours. That's when the pubDate of the channel changes. All date-times in RSS conform to the Date and Time Specification of RFC 822, with the exception that the year may be expressed with two characters or four characters (four preferred).

var rating: String? = null

The PICS rating for the channel.

var skipDays: SkipDays? = null

A hint for aggregators telling them which days they can skip. This element contains up to seven sub-elements whose value is Monday, Tuesday, Wednesday, Thursday, Friday, Saturday or Sunday. Aggregators may not read the channel during days listed in the element.

var skipHours: SkipHours? = null

A hint for aggregators telling them which hours they can skip. This element contains up to 24 sub-elements whose value is a number between 0 and 23, representing a time in GMT, when aggregators, if they support the feature, may not read the channel on hours listed in the element. The hour beginning at midnight is hour zero.

var textInput: TextInput? = null

Specifies a text input box that can be displayed with the channel. More info here.

var title: String

The name of the channel. It's how people refer to your service. If you have an HTML website that contains the same information as your RSS file, the title of your channel should be the same as the title of your website.

var ttl: Int? = null

ttl stands for time to live. It's a number of minutes that indicates how long a channel can be cached before refreshing from the source. More info here.

var webMaster: String? = null

Email address for person responsible for technical issues relating to channel.

Sources