https.Encoding

Note:

JavaScript does not include an enumeration type. The SuiteScript 2.x documentation uses the term enumeration (or enum) to describe a plain JavaScript object with a flat, map-like structure. In this object, each key points to a read-only string value.

Enum Description

Holds the string values for supported encoding types. Use this enum to set the value of parameters in SecureString.appendString(options), SecureString.convertEncoding(options), https.createSecureString(options).

Sibling Module Members

N/https Module Members

Module

N/https Module

Values

Value

UTF_8

BASE_16

BASE_32

BASE_64

BASE_64_URL_SAFE

HEX

Properties

BASE_64_URL_SAFE uses a different character set compared to BASE64, where the following properties apply:

  • +is replaced with -

  • / is replaced with _

  • Padding is still present and represented by character =

  • Use SecureString.replaceString to remove padding or replace it with URL-encoded form %3D.

See: Base-N Encodings

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/https Module Script Samples.

            // Add additional code 
...
var mySecretKey = https.createSecretKey({
    encoding: https.Encoding.HEX,
    guid: '284CFB2D225B1D76FB94D150207E49DF'
});
...
// Add additional code 

          

Related Topics

General Notices