Cipher.final(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description	Returns the cipher data. Sets the output encoding for the crypto.CipherPayload object.
Returns	A crypto.CipherPayload object.
Supported Script Types	Server scripts For additional information, see SuiteScript 2.x Script Types.
Governance	None
Module	N/crypto Module
Since	2015.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description
options.outputEncoding	enum	optional	The output encoding for a crypto.CipherPayload object. Use the encode.Encoding enum to set the value. The default value is encode.Encoding.HEX.

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/crypto Module Script Samples.

          //Add additional code 
...
myCipher = crypto.createCipher({ // myCipher is a crypto.Cipher object
    algorithm: crypto.EncryptionAlg.AES,
    key: sKey
});

var cipherPayload = myCipher.final({
    outputEncoding: encode.Encoding.BASE_64
});
...
//Add additional code 

        

Related Topics

crypto.Cipher

N/crypto Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices