Diffusion .NET Client Library  6.1.5
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
PushTechnology.ClientInterface.Client.Content.IRecordBuilder Interface Reference

The record builder. More...

Inherited by PushTechnology.ClientInterface.Client.Content.RecordBuilder.

Public Member Functions

IRecordBuilder Add (params string[] fields)
 Adds one or more fields to the end of the record. More...
 
IRecordBuilder Add (ICollection< object > fields)
 Adds one or more fields to the end of the record. More...
 
IRecordBuilder Add (int index, string field)
 Inserts a field at a specified index within the record, moving subsequent fields along the record. More...
 
IRecordBuilder Remove (int index)
 Removes a specified field from the record. More...
 
IRecordBuilder Set (int index, string field)
 Replaces a field at a specified index within the record. More...
 
IRecordBuilder Reset ()
 Resets the builder to its initial state. More...
 
IRecord Build ()
 Builds the record. More...
 

Detailed Description

The record builder.

If null is supplied for any field then a zero-length string ("") is written to the record.

Member Function Documentation

IRecordBuilder PushTechnology.ClientInterface.Client.Content.IRecordBuilder.Add ( params string[]  fields)

Adds one or more fields to the end of the record.

Parameters
fieldsA list of fields to add.
Returns
The builder.
IRecordBuilder PushTechnology.ClientInterface.Client.Content.IRecordBuilder.Add ( ICollection< object >  fields)

Adds one or more fields to the end of the record.

A collection of any type may be supplied and the ToString() value of each object will be used as the string value.

If any field value is null it will be written as an empty field, i.e. a zero-length string.

Parameters
fieldsThe collection of field objects to add.
Returns
The builder.
IRecordBuilder PushTechnology.ClientInterface.Client.Content.IRecordBuilder.Add ( int  index,
string  field 
)

Inserts a field at a specified index within the record, moving subsequent fields along the record.

Parameters
indexThe index to add a field at.
fieldThe field to add.
Returns
The builder.
IRecord PushTechnology.ClientInterface.Client.Content.IRecordBuilder.Build ( )

Builds the record.

Returns
The new record.
IRecordBuilder PushTechnology.ClientInterface.Client.Content.IRecordBuilder.Remove ( int  index)

Removes a specified field from the record.

Parameters
indexThe index of the field to remove.
Returns
The builder.
IRecordBuilder PushTechnology.ClientInterface.Client.Content.IRecordBuilder.Reset ( )

Resets the builder to its initial state.

Returns
The builder.
IRecordBuilder PushTechnology.ClientInterface.Client.Content.IRecordBuilder.Set ( int  index,
string  field 
)

Replaces a field at a specified index within the record.

Parameters
indexThe index of the field to replace.
fieldThe new field.
Returns
The builder.

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