A class for parsing text AdWords reports into POCOs. More...

Inheritance diagram for Google.Api.Ads.AdWords.Util.Reports.AwReport< A >:

Public Member Functions
	AwReport (InputTextReader reader, string reportName, Action< ColumnValuePair, A > onError)
	Constructor. More...

	AwReport (InputTextReader reader, string reportName)
	Constructor that provides the default throw-exception callback action upon parse error. More...

IEnumerable< A >	GetRows ()
	Returns a read only collection of POCOs of the rows of the report. Calling this forces this to walk through the entire text reader. More...

bool	MoveNext ()
	Advances the text reader forward one row. This does not parse the new row into the POCO type. Once reaching the end of the text reader this will return false. More...

void	Dispose ()
	Disposes the underlying reader and prevents moving to the next row. More...

void	Reset ()
	Throws an not supported exception because the does not support being reset. More...

Properties
string	ReportName `[get, set]`
	A name given to this report given in the constructor. More...

Action< ColumnValuePair, A >	OnError `[get, set]`
	A given action that is used when there is an error in parsing an attribute from the report. More...

IEnumerable< A >	Rows `[get]`
	Returns a read only collection of POCOs of the rows of the report. Calling this forces this AwReport to walk through the entire text reader. More...

A	Current `[get]`
	Gets the most recently parsed row of the report. If we have walked through the entire report, then this will be the final row. More...

Detailed Description

A class for parsing text AdWords reports into POCOs.

Template Parameters

A	A type that holds data for one row of an AdWords report where the properties have names matching those of columns in the report and are annotated with [ReportColumn].

Type Constraints

A

:

new()

Constructor & Destructor Documentation

Google.Api.Ads.AdWords.Util.Reports.AwReport< A >.AwReport	(	InputTextReader	reader,
		string	reportName,
		Action< ColumnValuePair, A >	onError
	)

inline

Constructor.

Parameters

reader	Provides the text of the report.
reportName	An arbitrary name given to this report.
onError	A callback action that is used when there is an error in parsing an attribute from the report.

Google.Api.Ads.AdWords.Util.Reports.AwReport< A >.AwReport	(	InputTextReader	reader,
		string	reportName
	)

inline

Constructor that provides the default throw-exception callback action upon parse error.

Parameters

reader	Provides the text of the report.
reportName	An arbitrary name given to this report.

Member Function Documentation

void Google.Api.Ads.AdWords.Util.Reports.AwReport< A >.Dispose ( )

inline

Disposes the underlying reader and prevents moving to the next row.

IEnumerable<A> Google.Api.Ads.AdWords.Util.Reports.AwReport< A >.GetRows ( )

inline

Returns a read only collection of POCOs of the rows of the report. Calling this forces this to walk through the entire text reader.

Returns: A read only collection of all the rows of the report.

bool Google.Api.Ads.AdWords.Util.Reports.AwReport< A >.MoveNext ( )

inline

Advances the text reader forward one row. This does not parse the new row into the POCO type. Once reaching the end of the text reader this will return false.

Returns: True if the reader was advanced to the next row. False if end was reached.

void Google.Api.Ads.AdWords.Util.Reports.AwReport< A >.Reset ( )

inline

Throws an not supported exception because the does not support being reset.

Property Documentation

A Google.Api.Ads.AdWords.Util.Reports.AwReport< A >.Current

get

Gets the most recently parsed row of the report. If we have walked through the entire report, then this will be the final row.

Returns: A row of the report.

Action<ColumnValuePair, A> Google.Api.Ads.AdWords.Util.Reports.AwReport< A >.OnError

getset

A given action that is used when there is an error in parsing an attribute from the report.

string Google.Api.Ads.AdWords.Util.Reports.AwReport< A >.ReportName

getset

A name given to this report given in the constructor.

IEnumerable<A> Google.Api.Ads.AdWords.Util.Reports.AwReport< A >.Rows

get

Returns a read only collection of POCOs of the rows of the report. Calling this forces this AwReport to walk through the entire text reader.

Returns: A read only collection of all the rows of the report.

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

dist/github/src/AdWords/Util/Reports/Parser/AwReport.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation