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

  •   callName

    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
  •   countsTowardAggregate

    Whether use of this call counts toward the application's
    aggregate limit for all calls.

    property
  •   dailyHardLimit

    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
  •   dailySoftLimit

    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
  •   dailyUsage

    The number of times your application has used this
    call today.

    property
  •   hourlyHardLimit

    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
  •   hourlySoftLimit

    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
  •   hourlyUsage

    The number of times your application has executed this call during this hour.

    property
  •   period

    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
  •   periodicHardLimit

    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
  •   periodicSoftLimit

    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
  •   periodicUsage

    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
  •   periodicStartDate

    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
  •   modTime

    The date and time this access rule was last modified by eBay.

    property
  •   ruleCurrentStatus

    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
  •   ruleStatus

    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
  •   any

    (public property)

    property

Properties

any

(public property)

@property (nonatomic, retain) NSMutableArray *any

Discussion

(public property)

entry type : PicoAnyElement, wrapper for primitive anyelement

Declared In

Trading_ApiAccessRuleType.h

callName

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 *callName

Discussion

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.h

countsTowardAggregate

Whether use of this call counts toward the application's
aggregate limit for all calls.

@property (nonatomic, retain) NSNumber *countsTowardAggregate

Discussion

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.h

dailyHardLimit

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 *dailyHardLimit

Discussion

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.h

dailySoftLimit

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 *dailySoftLimit

Discussion

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.h

dailyUsage

The number of times your application has used this
call today.

@property (nonatomic, retain) NSNumber *dailyUsage

Discussion

The number of times your application has used this
call today.

type : NSNumber, wrapper for primitive long

Declared In

Trading_ApiAccessRuleType.h

hourlyHardLimit

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 *hourlyHardLimit

Discussion

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.h

hourlySoftLimit

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 *hourlySoftLimit

Discussion

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.h

hourlyUsage

The number of times your application has executed this call during this hour.

@property (nonatomic, retain) NSNumber *hourlyUsage

Discussion

The number of times your application has executed this call during this hour.

type : NSNumber, wrapper for primitive long

Declared In

Trading_ApiAccessRuleType.h

modTime

The date and time this access rule was last modified by eBay.

@property (nonatomic, retain) NSDate *modTime

Discussion

The date and time this access rule was last modified by eBay.

type : NSDate, wrapper for primitive date

Declared In

Trading_ApiAccessRuleType.h

period

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 *period

Discussion

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.h

periodicHardLimit

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 *periodicHardLimit

Discussion

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.h

periodicSoftLimit

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 *periodicSoftLimit

Discussion

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.h

periodicStartDate

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 *periodicStartDate

Discussion

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.h

periodicUsage

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 *periodicUsage

Discussion

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.h

ruleCurrentStatus

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 *ruleCurrentStatus

Discussion

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.h

ruleStatus

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 *ruleStatus

Discussion

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