PHP Class Api\ServiceType\ApiCreate

Inheritance: extends WsdlToPhp\PackageBase\AbstractSoapClientBase
Datei anzeigen Open project: wsdltophp/packagegenerator

Public Methods

Method Description
CreateQueue ( Api\StructType\ApiCreateQueue $body ) : Api\StructType\ApiCreateQueueResponse | boolean Method to call the operation originally named CreateQueue Meta informations extracted from the WSDL - documentation: The CreateQueue action creates a new queue, or returns the URL of an existing one. When you request CreateQueue, you provide a name for the queue. To successfully create a new queue, you must provide a name that is unique within the scope of your own queues. If you provide the name of an existing queue, a new queue isn't created and an error isn't returned. Instead, the request succeeds and the queue URL for the existing queue is returned. A CreateQueue call may include attributes to set on a newly created queue. The effect is the same as the CreateQueue call followed by a SetQueueAttributes call (with the same attributes). However, when the queue already exists CreateQueue will not update any attributes. It simply compares the attribute values provided with the current settings on the existing queue, and returns the queue URL if the values match. Otherwise, it responds with an error otherwise. SetQueueAttributes should be used to change the values of attributes for an existing queue.
__toString ( ) : string Method returning the class name
getResult ( ) : Api\StructType\ApiCreateQueueResponse Returns the result

Method Details

CreateQueue() public method

Method to call the operation originally named CreateQueue Meta informations extracted from the WSDL - documentation: The CreateQueue action creates a new queue, or returns the URL of an existing one. When you request CreateQueue, you provide a name for the queue. To successfully create a new queue, you must provide a name that is unique within the scope of your own queues. If you provide the name of an existing queue, a new queue isn't created and an error isn't returned. Instead, the request succeeds and the queue URL for the existing queue is returned. A CreateQueue call may include attributes to set on a newly created queue. The effect is the same as the CreateQueue call followed by a SetQueueAttributes call (with the same attributes). However, when the queue already exists CreateQueue will not update any attributes. It simply compares the attribute values provided with the current settings on the existing queue, and returns the queue URL if the values match. Otherwise, it responds with an error otherwise. SetQueueAttributes should be used to change the values of attributes for an existing queue.
public CreateQueue ( Api\StructType\ApiCreateQueue $body ) : Api\StructType\ApiCreateQueueResponse | boolean
$body Api\StructType\ApiCreateQueue
return Api\StructType\ApiCreateQueueResponse | boolean

__toString() public method

Method returning the class name
public __toString ( ) : string
return string __CLASS__

getResult() public method

Returns the result
See also: AbstractSoapClientBase::getResult()
public getResult ( ) : Api\StructType\ApiCreateQueueResponse
return Api\StructType\ApiCreateQueueResponse