Trading_ApiAccessRuleType Class Reference
| Inherits from | NSObject | 
| Conforms to | PicoBindable | 
| Declared in | Trading_ApiAccessRuleType.h Trading_ApiAccessRuleType.m | 
Overview
Contains the definition of a rule that governs the number of times your
application can access the eBay API (invoke a call) on an hourly, daily, or
periodic basis.
@ingroup EBayAPIInterface
Tasks
- 
	
		callNameThe name of the call that has an access rule. Can be a call name (e.g., property
 AddItem), ApplicationAggregate (returns totals for all calls),
 PasswordAuthenticationLimiter (dummy call), or NonUTF8UsageLimiter.
- 
	
		countsTowardAggregateWhether use of this call counts toward the application's property
 aggregate limit for all calls.
- 
	
		dailyHardLimitThe number of calls per day that your application can make to this call before property
 being refused.
 The day starts at midnight, 00:00:00 PST (not GMT).
- 
	
		dailySoftLimitThe number of calls per day that your application can make to this call property
 before you receive a warning.
 The day starts at midnight, 00:00:00 PST.
- 
	
		dailyUsageThe number of times your application has used this property
 call today.
- 
	
		hourlyHardLimitThe number of calls that your application can make per hour to this call property
 before being refused. Each count begins on the hour (e.g. 1:00:00).
- 
	
		hourlySoftLimitThe number of calls that your application can make to this call per hour property
 before you receive a warning. Each count begins on the hour (e.g. 1:00:00).
- 
	
		hourlyUsageThe number of times your application has executed this call during this hour. property
- 
	
		periodThe length of time before your application’s perodic usage counter restarts property
 for this call. If the number of calls you make exceeds the periodic hard limit
 before the current period ends, further calls will be refused until the next
 period starts. Possible values: -1 (Periodic limit not enforced, could be any
 negative integer), 0 (Calendar month), 30 (Number of days, could be any
 positive integer). If the period is based on the calendar month, the usage
 counters restart on the same day of every month, regardless of the number of
 days in the month.
- 
	
		periodicHardLimitNumber of calls per period that your application may make before a call is property
 refused, if the periodic limit is enforced. The length of the period is
 specified in Period.
- 
	
		periodicSoftLimitNumber of calls per period that your application may make before you receive a property
 warning, if the periodic limit is enforced. The length of the period is
 specified in Period.
- 
	
		periodicUsageNumber of calls that your application has already made this period. Returns 0 property
 if the periodic access rule has not been configured for the application. The
 length of the period is specified in Period. The start date of the period is
 specified in PeriodicStartDate.
- 
	
		periodicStartDateThe time (in GMT) when this access rule’s period started. The period starts at property
 midnight Pacific time. For example, if the period begins on June 29 in 2005
 when California is on Pacific Daylight Time, the GMT value returned would be
 2005-06-29T07:00:00.000Z If the period begins on December 29 in 2005 when
 California is on Pacific Standard Time, the GMT value returned would be
 2005-12-29T08:00:00.000Z. Only returned when the eBay Developers Program has
 configured the start date for the access rule. The start date can vary per
 application and per call name (i.e., per access rule).
- 
	
		modTimeThe date and time this access rule was last modified by eBay. property
- 
	
		ruleCurrentStatusYour application’s current status for this rule, including whether the rule is property
 set for your application and whether the application has exceeded its daily or
 hourly limit.
- 
	
		ruleStatusThe status of the access rule, including whether the rule is turned on or off property
 and whether the application is currently blocked from using this call. No
 effect if RuleCurrentStatus is set to NotSet.
- 
	
		any(public property) property
Properties
any
(public property)
@property (nonatomic, retain) NSMutableArray *anyDiscussion
(public property)
entry type : PicoAnyElement, wrapper for primitive anyelement
Declared In
Trading_ApiAccessRuleType.hcallName
The name of the call that has an access rule. Can be a call name (e.g.,
AddItem), ApplicationAggregate (returns totals for all calls),
PasswordAuthenticationLimiter (dummy call), or NonUTF8UsageLimiter.
@property (nonatomic, retain) NSString *callNameDiscussion
The name of the call that has an access rule. Can be a call name (e.g.,
AddItem), ApplicationAggregate (returns totals for all calls),
PasswordAuthenticationLimiter (dummy call), or NonUTF8UsageLimiter.
type : NSString, wrapper for primitive string
Declared In
Trading_ApiAccessRuleType.hcountsTowardAggregate
Whether use of this call counts toward the application's
aggregate limit for all calls.
@property (nonatomic, retain) NSNumber *countsTowardAggregateDiscussion
Whether use of this call counts toward the application's
aggregate limit for all calls.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ApiAccessRuleType.hdailyHardLimit
The number of calls per day that your application can make to this call before
being refused.
The day starts at midnight, 00:00:00 PST (not GMT).
@property (nonatomic, retain) NSNumber *dailyHardLimitDiscussion
The number of calls per day that your application can make to this call before
being refused.
The day starts at midnight, 00:00:00 PST (not GMT).
type : NSNumber, wrapper for primitive long
Declared In
Trading_ApiAccessRuleType.hdailySoftLimit
The number of calls per day that your application can make to this call
before you receive a warning.
The day starts at midnight, 00:00:00 PST.
@property (nonatomic, retain) NSNumber *dailySoftLimitDiscussion
The number of calls per day that your application can make to this call
before you receive a warning.
The day starts at midnight, 00:00:00 PST.
type : NSNumber, wrapper for primitive long
Declared In
Trading_ApiAccessRuleType.hdailyUsage
  The number of times your application has used this
  call today.
@property (nonatomic, retain) NSNumber *dailyUsageDiscussion
  The number of times your application has used this
  call today.
type : NSNumber, wrapper for primitive long
Declared In
Trading_ApiAccessRuleType.hhourlyHardLimit
The number of calls that your application can make per hour to this call
before being refused. Each count begins on the hour (e.g. 1:00:00).
@property (nonatomic, retain) NSNumber *hourlyHardLimitDiscussion
The number of calls that your application can make per hour to this call
before being refused. Each count begins on the hour (e.g. 1:00:00).
type : NSNumber, wrapper for primitive long
Declared In
Trading_ApiAccessRuleType.hhourlySoftLimit
The number of calls that your application can make to this call per hour
before you receive a warning. Each count begins on the hour (e.g. 1:00:00).
@property (nonatomic, retain) NSNumber *hourlySoftLimitDiscussion
The number of calls that your application can make to this call per hour
before you receive a warning. Each count begins on the hour (e.g. 1:00:00).
type : NSNumber, wrapper for primitive long
Declared In
Trading_ApiAccessRuleType.hhourlyUsage
The number of times your application has executed this call during this hour.
@property (nonatomic, retain) NSNumber *hourlyUsageDiscussion
The number of times your application has executed this call during this hour.
type : NSNumber, wrapper for primitive long
Declared In
Trading_ApiAccessRuleType.hmodTime
The date and time this access rule was last modified by eBay.
@property (nonatomic, retain) NSDate *modTimeDiscussion
The date and time this access rule was last modified by eBay.
type : NSDate, wrapper for primitive date
Declared In
Trading_ApiAccessRuleType.hperiod
The length of time before your application’s perodic usage counter restarts
for this call. If the number of calls you make exceeds the periodic hard limit
before the current period ends, further calls will be refused until the next
period starts. Possible values: -1 (Periodic limit not enforced, could be any
negative integer), 0 (Calendar month), 30 (Number of days, could be any
positive integer). If the period is based on the calendar month, the usage
counters restart on the same day of every month, regardless of the number of
days in the month.
@property (nonatomic, retain) NSNumber *periodDiscussion
The length of time before your application’s perodic usage counter restarts
for this call. If the number of calls you make exceeds the periodic hard limit
before the current period ends, further calls will be refused until the next
period starts. Possible values: -1 (Periodic limit not enforced, could be any
negative integer), 0 (Calendar month), 30 (Number of days, could be any
positive integer). If the period is based on the calendar month, the usage
counters restart on the same day of every month, regardless of the number of
days in the month.
type : NSNumber, wrapper for primitive int
Declared In
Trading_ApiAccessRuleType.hperiodicHardLimit
Number of calls per period that your application may make before a call is
refused, if the periodic limit is enforced. The length of the period is
specified in Period.
@property (nonatomic, retain) NSNumber *periodicHardLimitDiscussion
Number of calls per period that your application may make before a call is
refused, if the periodic limit is enforced. The length of the period is
specified in Period.
type : NSNumber, wrapper for primitive long
Declared In
Trading_ApiAccessRuleType.hperiodicSoftLimit
Number of calls per period that your application may make before you receive a
warning, if the periodic limit is enforced. The length of the period is
specified in Period.
@property (nonatomic, retain) NSNumber *periodicSoftLimitDiscussion
Number of calls per period that your application may make before you receive a
warning, if the periodic limit is enforced. The length of the period is
specified in Period.
type : NSNumber, wrapper for primitive long
Declared In
Trading_ApiAccessRuleType.hperiodicStartDate
The time (in GMT) when this access rule’s period started. The period starts at
midnight Pacific time. For example, if the period begins on June 29 in 2005
when California is on Pacific Daylight Time, the GMT value returned would be
2005-06-29T07:00:00.000Z If the period begins on December 29 in 2005 when
California is on Pacific Standard Time, the GMT value returned would be
2005-12-29T08:00:00.000Z. Only returned when the eBay Developers Program has
configured the start date for the access rule. The start date can vary per
application and per call name (i.e., per access rule).
@property (nonatomic, retain) NSDate *periodicStartDateDiscussion
The time (in GMT) when this access rule’s period started. The period starts at
midnight Pacific time. For example, if the period begins on June 29 in 2005
when California is on Pacific Daylight Time, the GMT value returned would be
2005-06-29T07:00:00.000Z If the period begins on December 29 in 2005 when
California is on Pacific Standard Time, the GMT value returned would be
2005-12-29T08:00:00.000Z. Only returned when the eBay Developers Program has
configured the start date for the access rule. The start date can vary per
application and per call name (i.e., per access rule).
type : NSDate, wrapper for primitive date
Declared In
Trading_ApiAccessRuleType.hperiodicUsage
Number of calls that your application has already made this period. Returns 0
if the periodic access rule has not been configured for the application. The
length of the period is specified in Period. The start date of the period is
specified in PeriodicStartDate.
@property (nonatomic, retain) NSNumber *periodicUsageDiscussion
Number of calls that your application has already made this period. Returns 0
if the periodic access rule has not been configured for the application. The
length of the period is specified in Period. The start date of the period is
specified in PeriodicStartDate.
type : NSNumber, wrapper for primitive long
Declared In
Trading_ApiAccessRuleType.hruleCurrentStatus
Your application’s current status for this rule, including whether the rule is
set for your application and whether the application has exceeded its daily or
hourly limit.
@property (nonatomic, retain) NSString *ruleCurrentStatusDiscussion
Your application’s current status for this rule, including whether the rule is
set for your application and whether the application has exceeded its daily or
hourly limit.
type: string constant in Trading_AccessRuleCurrentStatusCodeType.h
Declared In
Trading_ApiAccessRuleType.hruleStatus
The status of the access rule, including whether the rule is turned on or off
and whether the application is currently blocked from using this call. No
effect if RuleCurrentStatus is set to NotSet.
@property (nonatomic, retain) NSString *ruleStatusDiscussion
The status of the access rule, including whether the rule is turned on or off
and whether the application is currently blocked from using this call. No
effect if RuleCurrentStatus is set to NotSet.
type: string constant in Trading_AccessRuleStatusCodeType.h
Declared In
Trading_ApiAccessRuleType.h