Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%ZEN] >  [Mobile] >  [RSS] >  [Feed]
Private  Storage   

persistent class %ZEN.Mobile.RSS.Feed extends %Persistent

This represents an RSS feed

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 7 6


Summary

Properties
Application Description Items Link Tag
Title URL

Methods
%AddToSaveSet %AddToSyncSet %BMEBuilt %CheckConstraints
%CheckConstraintsForExtent %ClassIsLatestVersion %ClassName %ComposeOid
%ConstructClone %Delete %DeleteExtent %DeleteId
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Exists
%ExistsId %Extends %GUID %GUIDSet
%GetLock %GetParameter %GetSwizzleObject %Id
%InsertBatch %IsA %IsModified %IsNull
%KillExtent %KillExtentData %LoadFromMemory %LockExtent
%LockId %New %NormalizeObject %ObjectIsNull
%ObjectModified %Oid %OnBeforeAddToSync %OnDetermineClass
%OnNew %Open %OpenId %OriginalNamespace
%PackageName %PhysicalAddress %PurgeIndices %Reload
%RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack %Save
%SaveDirect %SaveIndices %SerializeObject %SetModified
%SortBegin %SortEnd %SyncObjectIn %SyncTransport
%UnlockExtent %UnlockId %ValidateIndices %ValidateObject
BuildItem ExtractItemsFromResults FetchNetURL Refresh


Parameters

• parameter DEFAULTGLOBAL = "^ZEN.Mobile.RSS.Feed";

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

• relationship Application as Application [ Inverse = Feeds,Cardinality = parent ];
This defines the relationship to the parent
• property Description as %String(MAXLEN="") [ Required ];
This is a description of the contents of the feed
• relationship Items as Item [ Inverse = Feed,Cardinality = children ];
This represents the collection of items which makes up the feed
• property Link as %String(MAXLEN="") [ Required ];
This represents the URL at which the feed presents itself (derived from Channel/link)
• property Tag as %String(MAXLEN="");
This holds whatever data the user wishes to add to categorize this feed
• property Title as %String(MAXLEN="") [ Required ];
This is the Title of the feed (derived from Channel/title)
• property URL as %String(MAXLEN="") [ Required ];
This is the feed URL

Methods

• method %OnNew(pURL As %String, pTag As %String = "", pTimeout As %Integer = -1, pHttpRequest As %Net.HttpRequest = "") as %Status
This callback method is invoked by the %New method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

• classmethod BuildItem(ByRef pItem As %String) as %ZEN.Mobile.RSS.Item
• classmethod ExtractItemsFromResults(pResults As %ListOfObjects(CLASSNAME="%XML.XPATH.Result"), Output pItems) as %Status
This method extracts the retrieve item objects from the XPATH results
• classmethod FetchNetURL(pURL As %Status, Output pStream As %BinaryStream, pTimeout As %Integer = -1, pHttpRequest As %Net.HttpRequest = "") as %Status
Fetch the contents of a net URL
• method Refresh(Output pItemsFiled As %Integer, pPurgeCurrent As %Boolean, pTimeout As %Integer = -1, pHttpRequest As %Net.HttpRequest = "") as %Status
Call this method to refresh the items from the feed


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.