Invoke

Invokes an object method and returns the result of the invoked method.

Method Signature

Invoke(object=[any], method=[string], arguments=[any])

Arguments

Argument	Type	Required	Description	Default
object	any	true
method	string	false	The name of the method to invoke
arguments	any	false	An array of positional arguments or a struct of named arguments to pass into the method.

Examples

Invoke a Java Method

Invokes the size method on a new HashMap object, which should return 0

invoke( createObject( "java", "java.util.HashMap" ), "size" );

Result: 0

Invoke a method on a component

Invokes the method named 'test' on the component Test.bx with one parameter

obj = createObject( "component", "Test" );
invoke( obj, "test", {
	PARAMETER : "Test Data"
} );

Invoke a method on a webservice with one argument

Invokes the method named 'test' on the webservice Test.bx with one argument

obj = createObject( "webservice", "https://example.com/test.bx?wsdl" );
invoke( obj, "test", {
	ARGUMENT1 : "Test Data"
} );

Invoke a method on a webservice with multiple arguments

Invokes the method named 'test' on the webservice Test.bx with multiple arguments

obj = createObject( "webservice", "https://example.com/test.bx?wsdl" );
invoke( obj, "test", {
	ARGUMENT1 : "Test Data",
	ARGUMENT2 : "More Data",
	ARGUMENT3 : "Still More Data"
} );

Additional Examples

<bx:script>
	writeDump( label="structure with invoke()", var=invoke( variables, "myStruct", {
		A : "First"
	} ) );

	private function myStruct() {
		return "myStruct:" & JSONSerialize( arguments );
	}
	writeDump( label="Adding numbers with invoke()", var=invoke( variables, "calc", {
		A : 3,
		B : 2
	} ) );

	private function calc( numeric a, numeric b ) {
		return a + b;
	}
</bx:script>

Related

• Throw

• GetBaseTemplatePath

• Duplicate

• WriteLog

• BoxAnnounceAsync

• SessionRotate

• IsInstanceOf

• GetApplicationMetadata

• URLDecode

• GetFunctionList

• URLEncodedFormat

• ApplicationRestart

• GetModuleInfo

• CreateUUID

• GetTempDirectory

• GetSemver

• GetModuleList

• ApplicationStop

• SystemExecute

• IIF

• BoxModuleReload

• GetRequestClassLoader

• GetFunctionCalledName

• WriteOutput

• echo

• Print

• BoxRegisterRequestInterceptor

• ApplicationStartTime

• GetBoxContext

• CreateObject

• GetComponentList

• ObjectSerialize

• SessionInvalidate

• SessionStartTime

• BoxUnregisterRequestInterceptor

• GetFileFromPath

• EncodeForHTML

• htmlEditFormat

• GetClassMetadata

• SystemOutput

• JavaCast

• GetContextRoot

• GetTickCount

• CreateGUID

• Sleep

• DE

• GetBoxRuntime

• PagePoolClear

• GetCurrentTemplatePath

• Println

• SystemCacheClear

• GetSystemSetting

• RunThreadInContext

• GetBaseTagData

• BoxAnnounce

• BoxRegisterInterceptor

• BoxRegisterInterceptionPoints

• GetBoxVersionInfo

• Trace

• GetBaseTagList

• ObjectDeserialize

• DebugBoxContexts

• Dump

• writeDump

• BoxUnregisterInterceptor

• CallStackGet