HttpRequest.completed Event

Parent Object: HttpRequest
Defined in namespace "adsk::core" and the header file is <Core/Application/HttpRequest.h>

Description

The completed event fires when the request has completed. This event will fire on successful or failure.

Syntax

-------- Import ---------
# Import fusion360utils folder, which includes event_utils.py.
from ...lib import fusion360utils as futil

-------- Global variables ---------
# Global variable used to maintain a reference to all event handlers.
local_handlers = []

-------- Connect the handler to the event. ---------
# "httpRequest_var" is a variable referencing a HttpRequest object.
# "httpRequest_completed" is the event handler function.
futil.add_handler(httpRequest_var.completed, httpRequest_completed, local_handlers=local_handlers)

-------- Event handler function definition ---------
# Event handler for the completed event.
def httpRequest_completed(args: adsk.core.HttpEventArgs):
# Code to react to the event.
app.log('In httpRequest_completed event handler.')
-------- Global variables ---------
# Global variable used to maintain a reference to all event handlers.
handlers = []

-------- Connect the handler to the event. ---------
# "httpRequest_var" is a variable referencing a HttpRequest object.
# "MyCompletedHandler" is the name of the class that handles the event.
onCompleted = MyCompletedHandler()
httpRequest_var.completed.add(onCompleted)
handlers.append(onCompleted)

-------- Event handler class definition ---------
# Event handler for the completed event.
class MyCompletedHandler(adsk.core.HttpEventHandler):
def __init__(self):
super().__init__()
def notify(self, args: adsk.core.HttpEventArgs):
# Code to react to the event.
app.log('In MyCompletedHandler event handler.')
--------- Required include files. ---------
#include <Core/Application/HttpRequest.h>
#include <Core/Application/HttpEvent.h>
#include <Core/Application/HttpEventHandler.h>
#include <Core/Application/HttpEventArgs.h>


--------- Event handler class definition and global declaration. ---------
// Event handler for the completed event.
class MyCompletedEventHandler : public adsk::core::HttpEventHandler
{
public:
void notify(const Ptr<HttpEventArgs>& eventArgs) override
{
// Code to react to the event.
ui->messageBox("In MyCompletedEventHandler event handler.");
}
} _completed;

--------- Connect the handler to the event. ---------
// "httpRequest_var" is a variable referencing a HttpRequest object.
// Connect the handler function to the event.
Ptr<HttpEvent> completedEvent = httpRequest_var->completed();
if (!completedEvent)
return;

bool isOk = completedEvent->add(&_completed);
if (!isOk)
return;

Property Value

This is an event property that returns a HttpEvent.

Version

Introduced in version January 2024