%ZEN.Mobile.RSS.Application

persistent class %ZEN.Mobile.RSS.Application extends %Library.Persistent

SQL Table Name: %ZEN_Mobile_RSS.Application

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter DEFAULTGLOBAL = ^ZEN.Mobile.RSS.Application;
Inherited description:

If a persistent class uses %Storage.Persistent then the DEFAULTGLOBAL parameter is used as the default global root for the values of the storage keywords COUNTERLOCATION, DATALOCATION, IDLOCATION, INDEXLOCATION and STREAMLOCATION in the active storage definition. DEFAULTGLOBAL is only used to generate location keyword values that are not already defined. The location value is constructed by adding a location type to the end of DEFAULTGLOBAL. For example, if DEFAULTGLOBAL = "^GL.Account" the compiler will generate DATALOCATION = ^GL.AccountD.

If USEEXTENTSET is true, then DEFAULTGLOBAL is used as the default extent location.


The location types are:
LocationType
COUNTERLOCATIONC
DATALOCATIOND
IDLOCATIOND
INDEXLOCATIONI
STREAMLOCATIONS

Properties

property Description as %String (MAXLEN = 250) [ Required ];
This contains a short description of the application
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
relationship Feeds as array of Feed [ InitialExpression = $listbuild("%ZEN.Mobile.RSS.Feed","Application",+$this,"children",1,1) , Transient , Inverse = Application , Cardinality = children ];
The application manages a collection of Feeds
Property methods: FeedsGet(), FeedsGetObject(), FeedsGetObjectId(), FeedsGetSwizzled(), FeedsIsEmpty(), FeedsIsValid(), FeedsNewObject(), FeedsRClose(), FeedsRExec(), FeedsRFetch(), FeedsRelate(), FeedsSQLCompute(), FeedsSet(), FeedsUnRelate()
property Name as %String (MAXLEN = 75) [ Required ];
Together with the NameIndex, this property defines the primary key of this class enabling reference by name
Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIndexCheck(), NameIndexDelete(), NameIndexExists(), NameIndexOpen(), NameIndexSQLCheckUnique(), NameIndexSQLExists(), NameIndexSQLFindPKeyByConstraint(), NameIndexSQLFindRowIDByConstraint(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()

Methods

private method %OnNew(pName As %String = "", pDescription As %String = "") as %Status [ Language = objectscript ]
Assing the name and decription to the application
method GetSubscription(pURL As %String) as Feed [ Language = objectscript ]
This retreives a subscription by URL
method IsSubscribed(pURL As %String) as %Boolean [ Language = objectscript ]
Check to see if the application is already subscribed
method ListSubscriptions(Output pURLs As %String) as %Status [ Language = objectscript ]
Returns a list of subscriptions
method Subscribe(pURL As %String, pTag As %String = "", pTimeout As %Integer = -1, pHttpRequest As %Net.HttpRequest = "") as %Status [ Language = objectscript ]
Subscribe to a feed. Feed URL is required, an optional tag can be added which can be used to categorize the feed
method UnSubscribe(pURL As %String) as %Status [ Language = objectscript ]
UnSubscribe from a feed
method UpdateAllSubscriptions(Output pItemsUpdated As %Integer, Output pTimedOut As %Boolean = 0, pTimeout As %Integer = -1) as %Status [ Language = objectscript ]
Update All Subscriptions. This method will update all the subscriptions owned by this application by fetching the latest list of items and merging them into the database. If a timeout is supplied and exceeded the update will not fail, but report a TimedOut via the pTimedOut parameter. The total number of items updated is reported by the pItemsUpdated parameter
method UpdateOneSubscription(pURL As %String, pPurgeCurrent As %Boolean = 0, Output pTimeTaken, Output pItemsUpdated, pTimeout As %Integer = -1) as %Status [ Language = objectscript ]
Update One Subscription. Given a URL defining a feed, fetch the current items for the feed. If the pPurgeCurrent flag is set to true, then the previously stored contents of the feed will be purged. You can also pass an output parameter to receive the time taken to perform the operation, an output parameter to receive the number of items updated. For advanced usages a timeout and pre-configured HttpRequest object can be passed ( for example for https access, a HttpObject preconfigured with credentials is required )

Indices

index (NameIndex on Name) [IdKey, Type = key];
Index methods: NameIndexCheck(), NameIndexDelete(), NameIndexExists(), NameIndexOpen(), NameIndexSQLCheckUnique(), NameIndexSQLExists(), NameIndexSQLFindPKeyByConstraint(), NameIndexSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods (Including Private)

Storage

Storage Model: Storage (%ZEN.Mobile.RSS.Application)

^ZEN.Mobile.RSS.ApplicationD(ID)
=
%%CLASSNAME
Description
Feedback