FWebJSResponse

Representation of a remote JS async response object.

Windows
MacOS
Linux

Inheritance Hierarchy

FWebJSCallbackBase

FWebJSResponse

References

Module

WebBrowser

Header

/Engine/Source/Runtime/WebBrowser/Public/WebJSFunction.h

Include

#include "WebJSFunction.h"

Syntax

struct FWebJSResponse : public FWebJSCallbackBase

Remarks

Representation of a remote JS async response object. UFUNCTIONs taking a FWebJSResponse will get it passed in automatically when called from a web browser. Pass a result or error back by invoking Success or Failure on the object. UFunctions accepting a FWebJSResponse should have a void return type, as any value returned from the function will be ignored. Calling the response methods does not have to happen before returning from the function, which means you can use this to implement asynchronous functionality.

that the remote object will become invalid as soon as a result has been delivered, so you can only call either Success or Failure once.

Constructors

Name Description

Public function

FWebJSResponse()

Public function

FWebJSResponse

(
    TSharedPtr< FWebJSScripting > InScr...,
    const FGuid& InCallbackId
)

Functions

Name Description

Public function Const

void

 

Failure

(
    T Arg
)

Indicate failed completion, passing an error message back to JS.

Public function Const

void

 

Success()

Indicate successful completion without a return value.

Public function Const

void

 

Success

(
    T Arg
)

Indicate successful completion passing a return value back.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss