Cipher.update(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description

Updates the clear data with the specified encoding.

Returns

void

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.input

string

required

The clear data to be updated.

options.inputEncoding

enum

optional

The input encoding.

Use the encode.Encoding enum to set the value.

The default value is encode.Encoding.UTF-8.

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({ // cipher is a crypto.Cipher object
    algorithm: crypto.EncryptionAlg.AES,
    key: sKey
});

var reencoded = myCipher.update({
    input: 'Carrot cake gummi bears'
});
...
//Add additional code 

        

Related Topics

crypto.Cipher
N/crypto Module
SuiteScript 2.x Modules
SuiteScript 2.x

General Notices