eBay::API::XML::DataType::MyMessagesSummaryType - eBay::API::XML::DataType::MyMessagesSummaryType documentation

eBay-API documentation Contained in the eBay-API distribution.

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::MyMessagesSummaryType

DESCRIPTION

Top

Summary data for a given user's alerts and messages. This includes the numbers of new alerts and messages, unresolved alerts, flagged messages, and total alerts and messages.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::DataType::MyMessagesSummaryType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

Top

setFlaggedMessageCount()

The number of messages that have been flagged. Always returned for detail level ReturnSummary.

# Argument: 'xs:int'

getFlaggedMessageCount()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnSummary

# Returns: 'xs:int'

setFolderSummary()

Folder summary for each folder. Always returned for detail level ReturnSummary.

# Argument: reference to an array of 'ns:MyMessagesFolderSummaryType'

getFolderSummary()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnSummary

# Returns: reference to an array of 'ns:MyMessagesFolderSummaryType'

setNewAlertCount()

The number of new alerts that a given user has. Always returned for detail level ReturnSummary.

# Argument: 'xs:int'

getNewAlertCount()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnSummary

# Returns: 'xs:int'

setNewMessageCount()

The number of new messages that a given user has. Always returned for detail level ReturnSummary.

# Argument: 'xs:int'

getNewMessageCount()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnSummary

# Returns: 'xs:int'

setTotalAlertCount()

The total number of alerts for a given user. Always returned for detail level ReturnSummary.

# Argument: 'xs:int'

getTotalAlertCount()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnSummary

# Returns: 'xs:int'

setTotalMessageCount()

The total number of messages for a given user. Always returned for detail level ReturnSummary.

# Argument: 'xs:int'

getTotalMessageCount()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnSummary

# Returns: 'xs:int'

setUnresolvedAlertCount()

The number of alerts that are not yet resolved. Always returned for detail level ReturnSummary.

# Argument: 'xs:int'

getUnresolvedAlertCount()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnSummary

# Returns: 'xs:int'

eBay-API documentation Contained in the eBay-API distribution. 
#!/usr/bin/perl

package eBay::API::XML::DataType::MyMessagesSummaryType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. MyMessagesSummaryType.pm
# Generated by: ......... genEBayApiDataTypes.pl
# Last Generated: ....... 08/24/2008 16:44
# API Release Number: ... 579
#
##########################################################################  


use eBay::API::XML::BaseDataType;
our @ISA = ("eBay::API::XML::BaseDataType");

use eBay::API::XML::DataType::MyMessagesFolderSummaryType;


my @gaProperties = ( [ 'FlaggedMessageCount', 'xs:int', '', '', '' ]
	, [ 'FolderSummary', 'ns:MyMessagesFolderSummaryType', '1'
	     ,'eBay::API::XML::DataType::MyMessagesFolderSummaryType', '1' ]
	, [ 'NewAlertCount', 'xs:int', '', '', '' ]
	, [ 'NewMessageCount', 'xs:int', '', '', '' ]
	, [ 'TotalAlertCount', 'xs:int', '', '', '' ]
	, [ 'TotalMessageCount', 'xs:int', '', '', '' ]
	, [ 'UnresolvedAlertCount', 'xs:int', '', '', '' ]
                    );
push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};

my @gaAttributes = ( 
                    );
push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};


sub new {
  my $classname = shift;
  my %args = @_;
  my $self = $classname->SUPER::new(%args);
  return $self;
}

sub isScalar {
   return 0; 
}




sub setFlaggedMessageCount {
  my $self = shift;
  $self->{'FlaggedMessageCount'} = shift
}


sub getFlaggedMessageCount {
  my $self = shift;
  return $self->{'FlaggedMessageCount'};
}



sub setFolderSummary {
  my $self = shift;
  $self->{'FolderSummary'} = 
		$self->convertArray_To_RefToArrayIfNeeded(@_);
}


sub getFolderSummary {
  my $self = shift;
  return $self->_getDataTypeArray('FolderSummary');
}



sub setNewAlertCount {
  my $self = shift;
  $self->{'NewAlertCount'} = shift
}


sub getNewAlertCount {
  my $self = shift;
  return $self->{'NewAlertCount'};
}



sub setNewMessageCount {
  my $self = shift;
  $self->{'NewMessageCount'} = shift
}


sub getNewMessageCount {
  my $self = shift;
  return $self->{'NewMessageCount'};
}



sub setTotalAlertCount {
  my $self = shift;
  $self->{'TotalAlertCount'} = shift
}


sub getTotalAlertCount {
  my $self = shift;
  return $self->{'TotalAlertCount'};
}



sub setTotalMessageCount {
  my $self = shift;
  $self->{'TotalMessageCount'} = shift
}


sub getTotalMessageCount {
  my $self = shift;
  return $self->{'TotalMessageCount'};
}



sub setUnresolvedAlertCount {
  my $self = shift;
  $self->{'UnresolvedAlertCount'} = shift
}


sub getUnresolvedAlertCount {
  my $self = shift;
  return $self->{'UnresolvedAlertCount'};
}





##  Attribute and Property lists
sub getPropertiesList {
   my $self = shift;
   return \@gaProperties;
}

sub getAttributesList {
   my $self = shift;
   return \@gaAttributes;
}



1;