Trading_CharityInfoType Class Reference
Inherits from | NSObject |
Conforms to | PicoBindable |
Declared in | Trading_CharityInfoType.h Trading_CharityInfoType.m |
Overview
Type defining the Charity container, which consists of all details
related to a nonprofit charity organization.
@ingroup EBayAPIInterface
Tasks
-
name
The name of a non-profit charity organization. The Name field is
property
required if non-registered charity organization, since these companies will not have a
eBay Giving Works CharityID -
mission
The mission statement of a nonprofit charity organization registered with eBay Giving
property
Works. The mission statement is returned in GetCharities and is
displayed in item listings if the nonprofit charity organization is registered with
eBay Giving Works. -
logoURL
This URL indicates the location of the nonprofit charity organization’s logo image. The
property
image file must be JPG or GIF format, and its size cannot exceed 50 KB. This logo is
displayed in item listings if the nonprofit charity organization is registered with
eBay Giving Works. A standard eBay Giving Works logo is used in place of the charity
organization’s logo if the LogoURL or LogoURLSelling
values are not provided or these value point to bad URLs or to URLs containing no images
or images not meeting eBay logo size and format requirements. This value is returned if
set. -
status
Enumeration value that indicates whether or not the charity is a valid eBay Giving Works
property
nonprofit organization. -
searchableString
Keyword string to be used for search purposes.
property -
charityRegion
Integer value that indicates the nonprofit charity organization’s region. Each nonprofit
property
charity organization may be associated with only one region. -
charityDomain
Integer value that indicates the domain (mission area) of the nonprofit charity
property
organization. A nonprofit charity organization does not have to specify a charity
domain, so it is possible that this field will not be returned in
GetCharities. Each nonprofit charity organization can belong to as
many as three charity domains. -
charityID
A unique identifier created by eBay and assigned to registered nonprofit charity
property
organizations. This identifier can be used as a filter in the GetCharities
request, and it will always be returned if the nonprofity charity organization is
registered with eBay Giving Works. -
logoURLSelling
An alternative to the LogoURL value. This URL indicates the location
property
of the nonprofit charity organization’s logo image. The image file must be JPG or GIF
format, and its size cannot exceed 50 KB. This URL will be used if the
LogoURL value points to a broken link or if that location either
contains no image or contains an image that does not meet the eBay requirements - GIF or
JPG file; maximum size of 50 KB. A nonprofit charity organization’s logo is displayed in
item listings if the nonprofit charity organization is registered with eBay Giving
Works. A standard eBay Giving Works logo is used in place of the charity organization's
logo if the Logo URL is not provided. This value is returned if set. -
displayLogoSelling
Deprecated. This field will be removed from the schema
property
in a future release. Recommended to use IsFeaturedInSYI.
This boolean value should be set to true if an alternate logo URL should
be supplied by sellers using the eBay Sell Your Item flow. If this field
has not been set to true, it will return the default value of false. -
displayNameInCheckout
Deprecated. This field will be removed from the schema
property
in a future release. Recommended to use a combination of
IsFeaturedInXO/DisplayAtCheckout, based on the scenario.
Set this boolean value to true if the name of the nonprofit company should
be shown during checkout. If this field has not been set to true,
it will return the default value of false. If the user rolls their mouse
over the name of the nonprofit company, they will see the nonprofit company's
mission statement. -
description
This field provides a short description about the nonprofit charity organization's
property
primary purpose. “I want to support” will be added to the beginning of the contents of
this field. For example, if the description is “the fight against cancer”, then on the
checkout page “I want to support the fight against cancer” will be displayed. The
description may contain a maximum of 115 charecters. This value is returned if set. -
showMultipleDonationAmountInCheckout
This field must be used with the DisplayNameInCheckout field to control the options that are visible
property
to a buyer during checkout. If the
DisplayNameInCheckout field is set to True, and the ShowMultipleDonationAmountInCheckout
field is set to False, a checkbox with the one dollar option will be displayed during checkout.
If the DisplayNameInCheckout field is set to False, and the ShowMultipleDonationAmountInCheckout
field is set to False, no options will be displayed during checkout.
Reserved for future use. If the DisplayNameInCheckout field is set to True, and the
ShowMultipleDonationAmountInCheckout field is set to True, a dropdown with multiple donation amounts
will be displayed during checkout. If the DisplayNameInCheckout field is set to False, and the
ShowMultipleDonationAmountInCheckout field is set to True, no options will be displayed during checkout,
but the multiple donation amount field will be set. -
externalID
A unique identifier created and used by MissionFish to identify a registered nonprofit
property
charity organization. This field is only returned for charities that are registered with
MissionFish. -
popularityIndex
An integer value that indicates a nonprofit charity organization’s popularity rank in
property
comparison with other registered eBay Giving Works organizations. This value is
determined and managed by MissionFish and is based on various factors. This value is
always returned for nonprofit organizations registered with eBay Giving Works. -
ein
This value is the Employer Identification Number (EIN) of the nonprofit charity
property
organization. A nonprofit company’s EIN is used for tax purposes by the Internal
Revenue Service. This value is returned if the nonprofit organization has an EIN and
it has been set. -
nonProfitSecondName
An alternative name for the nonprofit charity organization. This value is used by
property
PayPal to search for nonprofit organizations. This value is returned if set. -
nonProfitAddress
Container consisting of the address (including latitude and longitude) of a nonprofit
property
charity organization. This container is always returned if it is set. -
nonProfitSocialAddress
Container consisting of the nonprofit charity organization’s social networking site ID/handle.
property
A NonProfitSocialAddress container will exist for each social
networking site that the charity organization is asssociated with. Supported social
networking sites include Facebook, Twitter, LinkedIn, Google+, MySpace, and Orkut. One
or more of these containers are returned if set. -
any
(public property)
property -
id
(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_CharityInfoType.h
charityDomain
Integer value that indicates the domain (mission area) of the nonprofit charity
organization. A nonprofit charity organization does not have to specify a charity
domain, so it is possible that this field will not be returned in
GetCharities. Each nonprofit charity organization can belong to as
many as three charity domains.
@property (nonatomic, retain) NSMutableArray *charityDomain
Discussion
Integer value that indicates the domain (mission area) of the nonprofit charity
organization. A nonprofit charity organization does not have to specify a charity
domain, so it is possible that this field will not be returned in
GetCharities. Each nonprofit charity organization can belong to as
many as three charity domains.
entry type : NSNumber, wrapper for primitive int
Declared In
Trading_CharityInfoType.h
charityID
A unique identifier created by eBay and assigned to registered nonprofit charity
organizations. This identifier can be used as a filter in the GetCharities
request, and it will always be returned if the nonprofity charity organization is
registered with eBay Giving Works.
@property (nonatomic, retain) NSString *charityID
Discussion
A unique identifier created by eBay and assigned to registered nonprofit charity
organizations. This identifier can be used as a filter in the GetCharities
request, and it will always be returned if the nonprofity charity organization is
registered with eBay Giving Works.
type : NSString, wrapper for primitive string
Declared In
Trading_CharityInfoType.h
charityRegion
Integer value that indicates the nonprofit charity organization’s region. Each nonprofit
charity organization may be associated with only one region.
@property (nonatomic, retain) NSNumber *charityRegion
Discussion
Integer value that indicates the nonprofit charity organization’s region. Each nonprofit
charity organization may be associated with only one region.
type : NSNumber, wrapper for primitive int
Declared In
Trading_CharityInfoType.h
description
This field provides a short description about the nonprofit charity organization's
primary purpose. “I want to support” will be added to the beginning of the contents of
this field. For example, if the description is “the fight against cancer”, then on the
checkout page “I want to support the fight against cancer” will be displayed. The
description may contain a maximum of 115 charecters. This value is returned if set.
@property (nonatomic, retain) NSString *description
Discussion
This field provides a short description about the nonprofit charity organization's
primary purpose. “I want to support” will be added to the beginning of the contents of
this field. For example, if the description is “the fight against cancer”, then on the
checkout page “I want to support the fight against cancer” will be displayed. The
description may contain a maximum of 115 charecters. This value is returned if set.
type : NSString, wrapper for primitive string
Declared In
Trading_CharityInfoType.h
displayLogoSelling
Deprecated. This field will be removed from the schema
in a future release. Recommended to use IsFeaturedInSYI.
This boolean value should be set to true if an alternate logo URL should
be supplied by sellers using the eBay Sell Your Item flow. If this field
has not been set to true, it will return the default value of false.
@property (nonatomic, retain) NSNumber *displayLogoSelling
Discussion
Deprecated. This field will be removed from the schema
in a future release. Recommended to use IsFeaturedInSYI.
This boolean value should be set to true if an alternate logo URL should
be supplied by sellers using the eBay Sell Your Item flow. If this field
has not been set to true, it will return the default value of false.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_CharityInfoType.h
displayNameInCheckout
Deprecated. This field will be removed from the schema
in a future release. Recommended to use a combination of
IsFeaturedInXO/DisplayAtCheckout, based on the scenario.
Set this boolean value to true if the name of the nonprofit company should
be shown during checkout. If this field has not been set to true,
it will return the default value of false. If the user rolls their mouse
over the name of the nonprofit company, they will see the nonprofit company's
mission statement.
@property (nonatomic, retain) NSNumber *displayNameInCheckout
Discussion
Deprecated. This field will be removed from the schema
in a future release. Recommended to use a combination of
IsFeaturedInXO/DisplayAtCheckout, based on the scenario.
Set this boolean value to true if the name of the nonprofit company should
be shown during checkout. If this field has not been set to true,
it will return the default value of false. If the user rolls their mouse
over the name of the nonprofit company, they will see the nonprofit company's
mission statement.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_CharityInfoType.h
ein
This value is the Employer Identification Number (EIN) of the nonprofit charity
organization. A nonprofit company’s EIN is used for tax purposes by the Internal
Revenue Service. This value is returned if the nonprofit organization has an EIN and
it has been set.
@property (nonatomic, retain) NSString *ein
Discussion
This value is the Employer Identification Number (EIN) of the nonprofit charity
organization. A nonprofit company’s EIN is used for tax purposes by the Internal
Revenue Service. This value is returned if the nonprofit organization has an EIN and
it has been set.
type : NSString, wrapper for primitive string
Declared In
Trading_CharityInfoType.h
externalID
A unique identifier created and used by MissionFish to identify a registered nonprofit
charity organization. This field is only returned for charities that are registered with
MissionFish.
@property (nonatomic, retain) NSString *externalID
Discussion
A unique identifier created and used by MissionFish to identify a registered nonprofit
charity organization. This field is only returned for charities that are registered with
MissionFish.
type : NSString, wrapper for primitive string
Declared In
Trading_CharityInfoType.h
id
(public property)
@property (nonatomic, retain) NSString *id
Discussion
(public property)
type : NSString, wrapper for primitive string
Declared In
Trading_CharityInfoType.h
logoURL
This URL indicates the location of the nonprofit charity organization’s logo image. The
image file must be JPG or GIF format, and its size cannot exceed 50 KB. This logo is
displayed in item listings if the nonprofit charity organization is registered with
eBay Giving Works. A standard eBay Giving Works logo is used in place of the charity
organization’s logo if the LogoURL or LogoURLSelling
values are not provided or these value point to bad URLs or to URLs containing no images
or images not meeting eBay logo size and format requirements. This value is returned if
set.
@property (nonatomic, retain) NSString *logoURL
Discussion
This URL indicates the location of the nonprofit charity organization’s logo image. The
image file must be JPG or GIF format, and its size cannot exceed 50 KB. This logo is
displayed in item listings if the nonprofit charity organization is registered with
eBay Giving Works. A standard eBay Giving Works logo is used in place of the charity
organization’s logo if the LogoURL or LogoURLSelling
values are not provided or these value point to bad URLs or to URLs containing no images
or images not meeting eBay logo size and format requirements. This value is returned if
set.
type : NSString, wrapper for primitive string
Declared In
Trading_CharityInfoType.h
logoURLSelling
An alternative to the LogoURL value. This URL indicates the location
of the nonprofit charity organization’s logo image. The image file must be JPG or GIF
format, and its size cannot exceed 50 KB. This URL will be used if the
LogoURL value points to a broken link or if that location either
contains no image or contains an image that does not meet the eBay requirements - GIF or
JPG file; maximum size of 50 KB. A nonprofit charity organization’s logo is displayed in
item listings if the nonprofit charity organization is registered with eBay Giving
Works. A standard eBay Giving Works logo is used in place of the charity organization's
logo if the Logo URL is not provided. This value is returned if set.
@property (nonatomic, retain) NSString *logoURLSelling
Discussion
An alternative to the LogoURL value. This URL indicates the location
of the nonprofit charity organization’s logo image. The image file must be JPG or GIF
format, and its size cannot exceed 50 KB. This URL will be used if the
LogoURL value points to a broken link or if that location either
contains no image or contains an image that does not meet the eBay requirements - GIF or
JPG file; maximum size of 50 KB. A nonprofit charity organization’s logo is displayed in
item listings if the nonprofit charity organization is registered with eBay Giving
Works. A standard eBay Giving Works logo is used in place of the charity organization's
logo if the Logo URL is not provided. This value is returned if set.
type : NSString, wrapper for primitive string
Declared In
Trading_CharityInfoType.h
mission
The mission statement of a nonprofit charity organization registered with eBay Giving
Works. The mission statement is returned in GetCharities and is
displayed in item listings if the nonprofit charity organization is registered with
eBay Giving Works.
@property (nonatomic, retain) NSString *mission
Discussion
The mission statement of a nonprofit charity organization registered with eBay Giving
Works. The mission statement is returned in GetCharities and is
displayed in item listings if the nonprofit charity organization is registered with
eBay Giving Works.
type : NSString, wrapper for primitive string
Declared In
Trading_CharityInfoType.h
name
The name of a non-profit charity organization. The Name field is
required if non-registered charity organization, since these companies will not have a
eBay Giving Works CharityID
@property (nonatomic, retain) NSString *name
Discussion
The name of a non-profit charity organization. The Name field is
required if non-registered charity organization, since these companies will not have a
eBay Giving Works CharityID
type : NSString, wrapper for primitive string
Declared In
Trading_CharityInfoType.h
nonProfitAddress
Container consisting of the address (including latitude and longitude) of a nonprofit
charity organization. This container is always returned if it is set.
@property (nonatomic, retain) NSMutableArray *nonProfitAddress
Discussion
Container consisting of the address (including latitude and longitude) of a nonprofit
charity organization. This container is always returned if it is set.
entry type : class Trading_NonProfitAddressType
Declared In
Trading_CharityInfoType.h
nonProfitSecondName
An alternative name for the nonprofit charity organization. This value is used by
PayPal to search for nonprofit organizations. This value is returned if set.
@property (nonatomic, retain) NSString *nonProfitSecondName
Discussion
An alternative name for the nonprofit charity organization. This value is used by
PayPal to search for nonprofit organizations. This value is returned if set.
type : NSString, wrapper for primitive string
Declared In
Trading_CharityInfoType.h
nonProfitSocialAddress
Container consisting of the nonprofit charity organization’s social networking site ID/handle.
A NonProfitSocialAddress container will exist for each social
networking site that the charity organization is asssociated with. Supported social
networking sites include Facebook, Twitter, LinkedIn, Google+, MySpace, and Orkut. One
or more of these containers are returned if set.
@property (nonatomic, retain) NSMutableArray *nonProfitSocialAddress
Discussion
Container consisting of the nonprofit charity organization’s social networking site ID/handle.
A NonProfitSocialAddress container will exist for each social
networking site that the charity organization is asssociated with. Supported social
networking sites include Facebook, Twitter, LinkedIn, Google+, MySpace, and Orkut. One
or more of these containers are returned if set.
entry type : class Trading_NonProfitSocialAddressType
Declared In
Trading_CharityInfoType.h
popularityIndex
An integer value that indicates a nonprofit charity organization’s popularity rank in
comparison with other registered eBay Giving Works organizations. This value is
determined and managed by MissionFish and is based on various factors. This value is
always returned for nonprofit organizations registered with eBay Giving Works.
@property (nonatomic, retain) NSNumber *popularityIndex
Discussion
An integer value that indicates a nonprofit charity organization’s popularity rank in
comparison with other registered eBay Giving Works organizations. This value is
determined and managed by MissionFish and is based on various factors. This value is
always returned for nonprofit organizations registered with eBay Giving Works.
type : NSNumber, wrapper for primitive int
Declared In
Trading_CharityInfoType.h
searchableString
Keyword string to be used for search purposes.
@property (nonatomic, retain) NSString *searchableString
Discussion
Keyword string to be used for search purposes.
type : NSString, wrapper for primitive string
Declared In
Trading_CharityInfoType.h
showMultipleDonationAmountInCheckout
This field must be used with the DisplayNameInCheckout field to control the options that are visible
to a buyer during checkout. If the
DisplayNameInCheckout field is set to True, and the ShowMultipleDonationAmountInCheckout
field is set to False, a checkbox with the one dollar option will be displayed during checkout.
If the DisplayNameInCheckout field is set to False, and the ShowMultipleDonationAmountInCheckout
field is set to False, no options will be displayed during checkout.
Reserved for future use. If the DisplayNameInCheckout field is set to True, and the
ShowMultipleDonationAmountInCheckout field is set to True, a dropdown with multiple donation amounts
will be displayed during checkout. If the DisplayNameInCheckout field is set to False, and the
ShowMultipleDonationAmountInCheckout field is set to True, no options will be displayed during checkout,
but the multiple donation amount field will be set.
@property (nonatomic, retain) NSNumber *showMultipleDonationAmountInCheckout
Discussion
This field must be used with the DisplayNameInCheckout field to control the options that are visible
to a buyer during checkout. If the
DisplayNameInCheckout field is set to True, and the ShowMultipleDonationAmountInCheckout
field is set to False, a checkbox with the one dollar option will be displayed during checkout.
If the DisplayNameInCheckout field is set to False, and the ShowMultipleDonationAmountInCheckout
field is set to False, no options will be displayed during checkout.
Reserved for future use. If the DisplayNameInCheckout field is set to True, and the
ShowMultipleDonationAmountInCheckout field is set to True, a dropdown with multiple donation amounts
will be displayed during checkout. If the DisplayNameInCheckout field is set to False, and the
ShowMultipleDonationAmountInCheckout field is set to True, no options will be displayed during checkout,
but the multiple donation amount field will be set.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_CharityInfoType.h
status
Enumeration value that indicates whether or not the charity is a valid eBay Giving Works
nonprofit organization.
@property (nonatomic, retain) NSString *status
Discussion
Enumeration value that indicates whether or not the charity is a valid eBay Giving Works
nonprofit organization.
type: string constant in Trading_CharityStatusCodeType.h
Declared In
Trading_CharityInfoType.h