Methods 1.1:cancelConversion/ru

From Aviberry API

К содержанию
Другие методы
Возникли вопросы?

cancelConversion - Метод отменяет задачу.

Сигнатура

boolean cancelConversion(
    mixed conversion_id
)

Параметры

conversion_id

conversion_id - Идентификатор задачи, которую необходимо отменить, или массив таких идентификаторов.
Тип: mixed.

Возвращаемое значение

Тип: boolean.
Результат вызова метода - true, если вызов был успешен, иначе false. Если при вызове метода был указан массив идентификаторов, то true будет возвращено только в случае, если все указанные конвертации были успешно отменены.
Если задача уже была завершена, то метод возвращает true, но сама задача не отменяется.
Если задача имеет статус uploading, то она получает статус canceled, но сохранение файла продолжается.

Примеры

XML-RPC

Вызов cancelConversion

<methodCall>
<methodName>cancelConversion</methodName>
<params>
    <param>
        <value>
            <string>2011_11-22_01_5116-72429800</string>
        </value>
    </param>
</params>
</methodCall>

Возвращаемое значение

<methodResponse>
<params>
    <param>
        <value>
            <boolean>1</boolean>
        </value>
    </param>
</params>
</methodResponse>

JSON-RPC

Вызов cancelConversion

{
    "version":"1.1",
    "method":"cancelConversion",
    "id":1,
    "params":
    {
        "conversion_id":"2011_11-22_01_5116-72429800"
    }
}

Возвращаемое значение

{
    "version":"1.1",
    "id":1,
    "result":true
}

К содержанию
Другие методы
Возникли вопросы?