Diffusion .NET API  5.9.24
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events Pages
PushTechnology.ClientInterface.Client.Topics.Update.IPagedRecordUnorderedUpdateFactory Interface Reference

Update factory for unordered TopicType.PAGED_RECORD topics. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Topics.Update.IPagedRecordUnorderedUpdateFactory:
PushTechnology.ClientInterface.Client.Topics.Update.IPagedUnorderedUpdateFactory PushTechnology.ClientInterface.Client.Topics.Update.IPagedUpdateFactory PushTechnology.ClientInterface.Client.Topics.Update.IUpdateFactory

Public Member Functions

IUpdate Add (params IRecord[] lines)
 Creates an update to add one or more lines of data to the end of the paged topic. More...
 
IUpdate Add (ICollection< IRecord > lines)
 Creates an update to add one or more lines of data to the end of the paged topic. More...
 
IUpdate Insert (int index, params IRecord[] lines)
 Creates an update to insert one or more lines of data into the paged topic at a specified index. More...
 
IUpdate Insert (int index, ICollection< IRecord > lines)
 Creates an update to insert one or more lines of data into the paged topic at the specified index. More...
 
IUpdate Update (int index, IRecord line)
 Create an update which will change a single line of data within the paged topic. More...
 
- Public Member Functions inherited from PushTechnology.ClientInterface.Client.Topics.Update.IPagedUnorderedUpdateFactory
IUpdate Remove (int index)
 Creates an update to remove a single line of data from the paged topic. More...
 
IUpdate Remove (int index, int number)
 Creates an update to remove one or more lines of data from the paged topic. More...
 
- Public Member Functions inherited from PushTechnology.ClientInterface.Client.Topics.Update.IPagedUpdateFactory
IUpdate RemoveAll ()
 Create an update which removes all lines from the paged topic. More...
 

Detailed Description

Update factory for unordered TopicType.PAGED_RECORD topics.

Instances of this factory can be obtained from the ITopicUpdateControl feature using ITopicUpdateControl.UpdateFactory{TF}, for example:

var updateControl = session.GetTopicUpdateControlFeature(); var factory = updateControl.UpdateFactory<IPagedRecordUnorderedUpdateFactory>();

Deprecated since 5.9.

Member Function Documentation

IUpdate PushTechnology.ClientInterface.Client.Topics.Update.IPagedRecordUnorderedUpdateFactory.Add ( params IRecord[]  lines)

Creates an update to add one or more lines of data to the end of the paged topic.

At the server all lines are added to the end of the data in a single operation causing a single notification to all interested clients.

Parameters
linesThe lines to add.
Returns
A new update.
IUpdate PushTechnology.ClientInterface.Client.Topics.Update.IPagedRecordUnorderedUpdateFactory.Add ( ICollection< IRecord lines)

Creates an update to add one or more lines of data to the end of the paged topic.

As Add( IRecord[] ) but specifying the lines as a collection.

Parameters
linesThe lines to add.
Returns
A new update.
IUpdate PushTechnology.ClientInterface.Client.Topics.Update.IPagedRecordUnorderedUpdateFactory.Insert ( int  index,
params IRecord[]  lines 
)

Creates an update to insert one or more lines of data into the paged topic at a specified index.

At the server all lines are inserted into the data in a single operation causing a single notification to all interested clients.

Parameters
indexThe index to insert the lines at. If this is zero then the lines will be inserted at the start of the data. If a negative value is supplied then zero is assumed. If the index is equal to or greater than the number of lines of data then the lines are added to the end.
linesThe lines of data to insert.
Returns
A new update.
IUpdate PushTechnology.ClientInterface.Client.Topics.Update.IPagedRecordUnorderedUpdateFactory.Insert ( int  index,
ICollection< IRecord lines 
)

Creates an update to insert one or more lines of data into the paged topic at the specified index.

As Insert( int, IRecord[] ) but specifying the lines as a collection.

Parameters
indexThe index to insert the lines at. If this is zero then the lines will be inserted at the start of the data. If a negative value is supplied then zero is assumed. If the index is equal to or greater than the number of lines of data then the lines are added to the end.
linesThe lines of data to insert.
Returns
A new update.
IUpdate PushTechnology.ClientInterface.Client.Topics.Update.IPagedRecordUnorderedUpdateFactory.Update ( int  index,
IRecord  line 
)

Create an update which will change a single line of data within the paged topic.

The line at the specified index is replaced by the specified line. If the index is equal to the current number of lines then the line is added to the end of the data. However, if the index is greater than the current number of lines then an error will be reported on the callback.

Parameters
indexThe index of the line to replace.
lineThe new line data.
Returns
A new update.

The documentation for this interface was generated from the following file: