dojox/atom/io/model.Feed (version 1.10)

Summary

Class container for 'Feed' types.

Usage

var foo = new model.Feed(args);
dojox/atom/io/model
Parameter Type Description
args undefined

Property Summary

Method Summary

  • _getAttributeNames()
  • _postBuild()
  • _saveAttributes(node)
  • accept(tag)
  • addAttribute(name,value)
  • addAuthor(name,email,uri) Function to add in an author to the list of authors.
  • addCategory(scheme,term,label) Function to add in a category to the list of categories.
  • addContent(content)
  • addContributor(name,email,uri) Function to add in an author to the list of authors.
  • addEntry(entry) Function to add an entry to this feed.
  • addExtension(name_space,name,attributes,content,shortNS) Function to add in an extension namespace into the item.
  • addLink(href,rel,hrefLang,title,type) Function to add in a link to the list of links.
  • addNamespace(fullName,shortName)
  • buildFromDom(node)
  • createEntry() Function to Create a new entry object in the feed.
  • destroy()
  • getAttribute(name)
  • getCategories(scheme) Function to get all categories that match a particular scheme.
  • getEntry(entryId) Function to get an entry by its id.
  • getExtensions(name_space,name) Function to get extensions that match a namespace and name.
  • getFirstEntry() Function to get the first entry of the feed.
  • getSelfHref() Function to get the href that refers to this feed.
  • removeBasicLinks() Function to remove all basic links from the list of links.
  • removeCategories(scheme,term) Function to remove all categories that match a particular scheme and term.
  • removeEntry(entry) Function to remove an entry from the list of links.
  • removeExtensions(name_space,name) Function to remove extensions that match a namespace and name.
  • removeLink(href,rel) Function to remove a link from the list of links.
  • setEntries(arrayOfEntry) Function to add a set of entries to the feed.
  • setTitle(str,type) Function to set the title of the item.
  • toString() Function to construct string form of the feed tag, which is an XML structure.

Properties

_accepts
Defined by: dojox/atom/io/model

Methods

_getAttributeNames()
Defined by dojox/atom/io/model
Returns:null
_postBuild()
Defined by dojox/atom/io/model
_saveAttributes(node)
Defined by dojox/atom/io/model
Parameter Type Description
node undefined
accept(tag)
Defined by dojox/atom/io/model
Parameter Type Description
tag undefined
Returns:undefined
addAttribute(name,value)
Defined by dojox/atom/io/model
Parameter Type Description
name undefined
value undefined
addAuthor(name,email,uri)
Defined by dojox/atom/io/model

Function to add in an author to the list of authors.

Parameter Type Description
name String

The author's name.
email String

The author's e-mail address.
uri String

A URI associated with the author.
addCategory(scheme,term,label)
Defined by dojox/atom/io/model

Function to add in a category to the list of categories.

Parameter Type Description
scheme String
term String
label String
addContent(content)
Defined by dojox/atom/io/model
Parameter Type Description
content undefined
addContributor(name,email,uri)
Defined by dojox/atom/io/model

Function to add in an author to the list of authors.

Parameter Type Description
name String

The author's name.
email String

The author's e-mail address.
uri String

A URI associated with the author.
addEntry(entry)
Defined by dojox/atom/io/model

Function to add an entry to this feed.

Parameter Type Description
entry object

The entry object to add.
addExtension(name_space,name,attributes,content,shortNS)
Defined by dojox/atom/io/model

Function to add in an extension namespace into the item.

Parameter Type Description
name_space String

The namespace of the extension.
name String

The name of the extension
attributes Array

The attributes associated with the extension.
content String

The content of the extension.
shortNS String
addLink(href,rel,hrefLang,title,type)
Defined by dojox/atom/io/model

Function to add in a link to the list of links.

Parameter Type Description
href String
rel String
hrefLang String
title String

A title to associate with the link.
type String

The type of link is is.
addNamespace(fullName,shortName)
Defined by dojox/atom/io/model
Parameter Type Description
fullName undefined
shortName undefined
buildFromDom(node)
Defined by dojox/atom/io/model
Parameter Type Description
node undefined
createEntry()
Defined by dojox/atom/io/model

Function to Create a new entry object in the feed.

Returns:any | instance

An empty entry object in the feed.

destroy()
Defined by dojox/atom/io/model
getAttribute(name)
Defined by dojox/atom/io/model
Parameter Type Description
name undefined
Returns:undefined
getCategories(scheme)
Defined by dojox/atom/io/model

Function to get all categories that match a particular scheme.

Parameter Type Description
scheme String

The scheme to filter on.
Returns:undefined | Array
getEntry(entryId)
Defined by dojox/atom/io/model

Function to get an entry by its id.

Parameter Type Description
entryId String
Returns:any | null | undefined

The entry desired, or null if none.

getExtensions(name_space,name)
Defined by dojox/atom/io/model

Function to get extensions that match a namespace and name.

Parameter Type Description
name_space String

The namespace of the extension.
name String

The name of the extension
Returns:Array
getFirstEntry()
Defined by dojox/atom/io/model

Function to get the first entry of the feed.

Returns:any | null | undefined

The first entry in the feed.

getSelfHref()
Defined by dojox/atom/io/model

Function to get the href that refers to this feed.

Returns:any | null | undefined

The href that refers to this feed or null if none.

removeBasicLinks()
Defined by dojox/atom/io/model

Function to remove all basic links from the list of links.

Returns:number
removeCategories(scheme,term)
Defined by dojox/atom/io/model

Function to remove all categories that match a particular scheme and term.

Parameter Type Description
scheme String

The scheme to filter on.
term String

The term to filter on.
Returns:number
removeEntry(entry)
Defined by dojox/atom/io/model

Function to remove an entry from the list of links.

Parameter Type Description
entry object

The entry.
Returns:number
removeExtensions(name_space,name)
Defined by dojox/atom/io/model

Function to remove extensions that match a namespace and name.

Parameter Type Description
name_space String

The namespace of the extension.
name String

The name of the extension
removeLink(href,rel)
Defined by dojox/atom/io/model

Function to remove a link from the list of links.

Parameter Type Description
href String

The href.
rel String
Returns:number
setEntries(arrayOfEntry)
Defined by dojox/atom/io/model

Function to add a set of entries to the feed.

Parameter Type Description
arrayOfEntry array

An array of entry objects to add to the feed.
setTitle(str,type)
Defined by dojox/atom/io/model

Function to set the title of the item.

Parameter Type Description
str String

The title to set.
type String

The type of title format, text, xml, xhtml, etc.
toString()
Defined by dojox/atom/io/model

Function to construct string form of the feed tag, which is an XML structure.

Returns:undefined
Error in the documentation? Can’t find what you are looking for? Let us know!