Trading_StoreCustomPageType Class Reference
Inherits from | NSObject |
Conforms to | PicoBindable |
Declared in | Trading_StoreCustomPageType.h Trading_StoreCustomPageType.m |
Tasks
-
name
Name of the eBay Store custom page. This value is required if you are creating a new
property
page (and omitting a PageID value). Note that you must include a
name for the page even if you are using the PreviewEnabled flag.
However, since using the preview functionality means that the page will not be
persisted, you can enter a dummy value for this field if you have not decided on a
name for the page. The Name value is used in links to the page. -
pageID
Unique identifier for an eBay Store custom page. If you specify a valid
property
PageID value in a
SetStoreCustomPage call, the existing custom page
is updated. If you do not specify a PageID value, you are
creating a new custom page.
The PageID field is always returned in
GetStoreCustomPage. -
urlPath
The URL path of the eBay Store custom page. This field is only required if you are
property
using Chinese characters in the Name field. The URL path of the
eBay Store custom page is normally derived from the Name field, but
the URL path cannot be derived from the name of the custom page if it contains Chinese
characters because URLs cannot contain Chinese characters.
The URLPath is only returned in the GetStoreCustomPage
response if it is defined for the eBay Store custom page, and if a PageID
value is included in the request. -
url
The full URL of the eBay Store custom page, which is generally derived from the
property
CustomPage.Name value. The exception to this rule is if the seller
specified a custom URL using the CustomPage.URLPath field in a
SetStoreCustomPage call.
The URL is only returned in the
GetStoreCustomPage response if a PageID value
is included in the request. -
status
This value indicates the status of the eBay custom page. In a
property
SetStoreCustomPage call, the seller uses the optional
Status field to make an inactive custom page active, to make an
active custom page inactive, or to delete an active or inactive custom page. To
change the status (including delete) of a custom page, a PageID
value must be included to identify the custom page to modify.
The Status value is always returned in the
GetStoreCustomPage response. -
content
The HTML content of the eBay Store custom page. This field has a maximum size of 96
property
kilobytes. If the PreviewEnabled field is set to ‘true’, then
this field is required in a SetStoreCustomPage call. Otherwise,
it is optional.
The Content field is only returned in the
GetStoreCustomPage response if a PageID value
is included in the request. -
leftNav
This flag controls whether or not the left navigation bar is included in the eBay
property
Store custom page. To include the left navigation bar in a custom page, the seller
will include the LeftNav field in the SetStoreCustomPage
request and set it to ‘true’.
The LeftNav field is only returned in the
GetStoreCustomPage response if a PageID value
is included in the request. -
previewEnabled
This flag controls whether or not a custom page preview is enabled. To enable the
property
a custom page preview, the seller will include the
PreviewEnabled field in the SetStoreCustomPage
request and set it to ‘true’.
The PreviewEnabled field is only returned in the
GetStoreCustomPage response if a PageID value
is included in the request. -
order
This integer value controls the order in which the corresponding eBay Store custom
property
page is displayed in the list of custom pages. To make the corresponding custom
page appear first in the list of custom pages, the seller would include the
Order field and set its value to ‘1’.
The Order value is always returned in the
GetStoreCustomPage response. -
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_StoreCustomPageType.h
content
The HTML content of the eBay Store custom page. This field has a maximum size of 96
kilobytes. If the PreviewEnabled field is set to ‘true’, then
this field is required in a SetStoreCustomPage call. Otherwise,
it is optional.
The Content field is only returned in the
GetStoreCustomPage response if a PageID value
is included in the request.
@property (nonatomic, retain) NSString *content
Discussion
The HTML content of the eBay Store custom page. This field has a maximum size of 96
kilobytes. If the PreviewEnabled field is set to ‘true’, then
this field is required in a SetStoreCustomPage call. Otherwise,
it is optional.
The Content field is only returned in the
GetStoreCustomPage response if a PageID value
is included in the request.
type : NSString, wrapper for primitive string
Declared In
Trading_StoreCustomPageType.h
leftNav
This flag controls whether or not the left navigation bar is included in the eBay
Store custom page. To include the left navigation bar in a custom page, the seller
will include the LeftNav field in the SetStoreCustomPage
request and set it to ‘true’.
The LeftNav field is only returned in the
GetStoreCustomPage response if a PageID value
is included in the request.
@property (nonatomic, retain) NSNumber *leftNav
Discussion
This flag controls whether or not the left navigation bar is included in the eBay
Store custom page. To include the left navigation bar in a custom page, the seller
will include the LeftNav field in the SetStoreCustomPage
request and set it to ‘true’.
The LeftNav field is only returned in the
GetStoreCustomPage response if a PageID value
is included in the request.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_StoreCustomPageType.h
name
Name of the eBay Store custom page. This value is required if you are creating a new
page (and omitting a PageID value). Note that you must include a
name for the page even if you are using the PreviewEnabled flag.
However, since using the preview functionality means that the page will not be
persisted, you can enter a dummy value for this field if you have not decided on a
name for the page. The Name value is used in links to the page.
@property (nonatomic, retain) NSString *name
Discussion
Name of the eBay Store custom page. This value is required if you are creating a new
page (and omitting a PageID value). Note that you must include a
name for the page even if you are using the PreviewEnabled flag.
However, since using the preview functionality means that the page will not be
persisted, you can enter a dummy value for this field if you have not decided on a
name for the page. The Name value is used in links to the page.
type : NSString, wrapper for primitive string
Declared In
Trading_StoreCustomPageType.h
order
This integer value controls the order in which the corresponding eBay Store custom
page is displayed in the list of custom pages. To make the corresponding custom
page appear first in the list of custom pages, the seller would include the
Order field and set its value to ‘1’.
The Order value is always returned in the
GetStoreCustomPage response.
@property (nonatomic, retain) NSNumber *order
Discussion
This integer value controls the order in which the corresponding eBay Store custom
page is displayed in the list of custom pages. To make the corresponding custom
page appear first in the list of custom pages, the seller would include the
Order field and set its value to ‘1’.
The Order value is always returned in the
GetStoreCustomPage response.
type : NSNumber, wrapper for primitive int
Declared In
Trading_StoreCustomPageType.h
pageID
Unique identifier for an eBay Store custom page. If you specify a valid
PageID value in a
SetStoreCustomPage call, the existing custom page
is updated. If you do not specify a PageID value, you are
creating a new custom page.
The PageID field is always returned in
GetStoreCustomPage.
@property (nonatomic, retain) NSNumber *pageID
Discussion
Unique identifier for an eBay Store custom page. If you specify a valid
PageID value in a
SetStoreCustomPage call, the existing custom page
is updated. If you do not specify a PageID value, you are
creating a new custom page.
The PageID field is always returned in
GetStoreCustomPage.
type : NSNumber, wrapper for primitive long
Declared In
Trading_StoreCustomPageType.h
previewEnabled
This flag controls whether or not a custom page preview is enabled. To enable the
a custom page preview, the seller will include the
PreviewEnabled field in the SetStoreCustomPage
request and set it to ‘true’.
The PreviewEnabled field is only returned in the
GetStoreCustomPage response if a PageID value
is included in the request.
@property (nonatomic, retain) NSNumber *previewEnabled
Discussion
This flag controls whether or not a custom page preview is enabled. To enable the
a custom page preview, the seller will include the
PreviewEnabled field in the SetStoreCustomPage
request and set it to ‘true’.
The PreviewEnabled field is only returned in the
GetStoreCustomPage response if a PageID value
is included in the request.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_StoreCustomPageType.h
status
This value indicates the status of the eBay custom page. In a
SetStoreCustomPage call, the seller uses the optional
Status field to make an inactive custom page active, to make an
active custom page inactive, or to delete an active or inactive custom page. To
change the status (including delete) of a custom page, a PageID
value must be included to identify the custom page to modify.
The Status value is always returned in the
GetStoreCustomPage response.
@property (nonatomic, retain) NSString *status
Discussion
This value indicates the status of the eBay custom page. In a
SetStoreCustomPage call, the seller uses the optional
Status field to make an inactive custom page active, to make an
active custom page inactive, or to delete an active or inactive custom page. To
change the status (including delete) of a custom page, a PageID
value must be included to identify the custom page to modify.
The Status value is always returned in the
GetStoreCustomPage response.
type: string constant in Trading_StoreCustomPageStatusCodeType.h
Declared In
Trading_StoreCustomPageType.h
url
The full URL of the eBay Store custom page, which is generally derived from the
CustomPage.Name value. The exception to this rule is if the seller
specified a custom URL using the CustomPage.URLPath field in a
SetStoreCustomPage call.
The URL is only returned in the
GetStoreCustomPage response if a PageID value
is included in the request.
@property (nonatomic, retain) NSString *url
Discussion
The full URL of the eBay Store custom page, which is generally derived from the
CustomPage.Name value. The exception to this rule is if the seller
specified a custom URL using the CustomPage.URLPath field in a
SetStoreCustomPage call.
The URL is only returned in the
GetStoreCustomPage response if a PageID value
is included in the request.
type : NSString, wrapper for primitive string
Declared In
Trading_StoreCustomPageType.h
urlPath
The URL path of the eBay Store custom page. This field is only required if you are
using Chinese characters in the Name field. The URL path of the
eBay Store custom page is normally derived from the Name field, but
the URL path cannot be derived from the name of the custom page if it contains Chinese
characters because URLs cannot contain Chinese characters.
The URLPath is only returned in the GetStoreCustomPage
response if it is defined for the eBay Store custom page, and if a PageID
value is included in the request.
@property (nonatomic, retain) NSString *urlPath
Discussion
The URL path of the eBay Store custom page. This field is only required if you are
using Chinese characters in the Name field. The URL path of the
eBay Store custom page is normally derived from the Name field, but
the URL path cannot be derived from the name of the custom page if it contains Chinese
characters because URLs cannot contain Chinese characters.
The URLPath is only returned in the GetStoreCustomPage
response if it is defined for the eBay Store custom page, and if a PageID
value is included in the request.
type : NSString, wrapper for primitive string
Declared In
Trading_StoreCustomPageType.h