The Listings class exposes specialized methods to help
developers to handle listings and listing requests.
Kind: global class
Category: Operations
Array
object
object
object
object
object
object
object
Creates an instance of the Listings class.
Returns:
Listings
– An instance of the Listings class.
Param | Type | Description |
---|---|---|
client |
ConnectClient
| An instance of the ConnectClient class. |
Array
Returns a list of ListingRequest objects that match the provided
(optional) query.
Kind: instance method of
Listings
Returns:
Array
– An array of ListingRequest object optionally matching
the provided query.
Param | Type | Description |
---|---|---|
query |
object
| The optional query to filter results. |
object
Creates a new ListingRequest
Kind: instance method of
Listings
Returns:
object
– The created ListingRequest object.
Param | Type | Description |
---|---|---|
request |
object
| The ListingRequest object. |
object
Retrieve the ListingRequest object identified by its id.
Kind: instance method of
Listings
Returns:
object
– The ListingRequest object.
Param | Type | Description |
---|---|---|
id |
string
| The unique identifier of the ListingRequest object. |
object
Submit the ListingRequest object identified by its id.
Kind: instance method of
Listings
Returns:
object
– The ListingRequest object.
Param | Type | Description |
---|---|---|
id |
string
| The unique identifier of the ListingRequest object. |
object
Cancel the ListingRequest object identified by its id.
Kind: instance method of
Listings
Returns:
object
– The ListingRequest object.
Param | Type | Description |
---|---|---|
id |
string
| The unique identifier of the ListingRequest object. |
object
Refine the ListingRequest object identified by its id.
Kind: instance method of
Listings
Returns:
object
– The ListingRequest object.
Param | Type | Description |
---|---|---|
id |
string
| The unique identifier of the ListingRequest object. |
object
Complete the ListingRequest object identified by its id.
Kind: instance method of
Listings
Returns:
object
– The ListingRequest object.
Param | Type | Description |
---|---|---|
id |
string
| The unique identifier of the ListingRequest object. |
object
Deploy the ListingRequest object identified by its id.
Kind: instance method of
Listings
Returns:
object
– The ListingRequest object.
Param | Type | Description |
---|---|---|
id |
string
| The unique identifier of the ListingRequest object. |