setFileForwardingState


Purpose

Sets the state of the file forwarding process.

The setFileForwardingState method controls the offline case attachments support. If enabled, you can use the writeBinaryItem and addActionWithItemReference methods.

Signature

setFileForwardingState( state )

Parameters

The table below describes the setFileForwardingState method parameters.

Name Description Type Use
state The state of the file forwarding process. By default it is enabled. boolean required

Returns

This method returns a promise object, which can be in one of the following states:

  • Resolve - confirms that the operation has completed successfully.

  • Reject - returns an object that is an instance of a generic Error class, as described below.

    {
      "name": error_code
      "message": detailed_message
    }

Where error_code stands for one of the error codes described in the Constants section of the Client Store article and detailed_message can be an additional message from the native side.

Related topics

Client Store
getFileForwardingState
Legal notice | Copyright © 2018 and Confidential to Pegasystems Inc. All rights reserved
PDN | Feedback
Advanced...