net.rim.device.api.synchronization
Interface SummaryParameterListener

public interface SummaryParameterListener

A SyncCollection that is interested in the summary parameter passed with the summary command should implement this interface. The summary parameter represents service information. The desktop sends a summary parameter along with a 'summarize database' command. Implement this interface to pass the summary parameter to a SyncCollection.

See Also:

StateInfoListener

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

Method Summary
	void	clearSummaryParameter() Called after a "summary" command has completed, regardless of whether setSummaryParameter() has been called.
	void	setSummaryParameter(DataBuffer db) Called when a parameter has been included with a "summary" command for the SyncCollection.

Method Detail

setSummaryParameter

void setSummaryParameter(DataBuffer db)

Called when a parameter has been included with a "summary" command for the SyncCollection.

Parameters:

db - The DataBuffer containing the summary parameter. This DataBuffer should not be rewound as it may contain data other than the summary parameter.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

clearSummaryParameter

void clearSummaryParameter()

Called after a "summary" command has completed, regardless of whether setSummaryParameter() has been called. This function should clear any state generated as a result of a call to setSummaryParameter().

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0