CancelNotification()

Description:

The CancelNotification method cancels an outstanding asynchronous call.

This is a synchronous method.

Syntax:

CancleNotification(parameters:Object):Object

Arguments:

  • parameters:

    This is an object that specifies whether to cancel a GetLocation call or a Trace call. The object must contain the CancelRequestType property (string) that is used to specify the type of call to cancel. The possible values for parameters.CancelRequestType are:

    • "GetLocCancel" cancels an asynchronous GetLocation call.

    • "TraceCancel" cancels a Trace call.

Return value:

The CancelNotification method returns an object that contains an error code and an error message.

Table: Return value properties for CancelNotification

Property

Description

Value

ErrorCode

This is a number that specifies a predefined error code.

See Service API error codes.

ErrorMessage

This is a text string that describes the error.

Example code:

The following sample code illustrates how to cancel an outstanding asynchronous call:

import com.nokia.lib.Service;
var location = new Service("Service.Location", "ILocation");
var inParams = {CancelRequestType:"TraceCancel"};
var outParams = location.CancelNotification(inParams);
var errorId = outParams.ErrorCode;