Apex Developer Guide

Apex Developer Guide
Getting Started with Apex
Writing Apex
Running Apex
Debugging, Testing, and Deploying Apex
Apex Language Reference
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
EventBus Namespace
Flow Namespace
KbManagement Namespace
Messaging Namespace
Metadata Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Site Namespace
Support Namespace
System Namespace
Address Class
Answers Class
ApexPages Class
Approval Class
Blob Class
Boolean Class
BusinessHours Class
Callable Interface
Cases Class
Comparable Interface
Continuation Class
Cookie Class
Crypto Class
Custom Settings Methods
Database Class
Date Class
Datetime Class
Decimal Class
Double Class
EncodingUtil Class
EncodingUtil Methods
Enum Methods
EventBus Class
Exception Class and Built-In Exceptions
FlexQueue Class
FeatureManagement Class
Http Class
HttpCalloutMock Interface
HttpRequest Class
HttpResponse Class
Id Class
Ideas Class
InstallHandler Interface
Integer Class
JSON Class
JSONGenerator Class
JSONParser Class
JSONToken Enum
Limits Class
List Class
Location Class
Long Class
Map Class
Matcher Class
Math Class
Messaging Class
MultiStaticResourceCalloutMock Class
Network Class
PageReference Class
Pattern Class
Queueable Interface
QueueableContext Interface
QuickAction Class
RemoteObjectController
ResetPasswordResult Class
RestContext Class
RestRequest Class
RestResponse Class
SandboxPostCopy Interface
Schedulable Interface
SchedulableContext Interface
Schema Class
Search Class
SelectOption Class
Set Class
Site Class
SObject Class
StaticResourceCalloutMock Class
String Class
StubProvider Interface
System Class
Test Class
Time Class
TimeZone Class
Trigger Class
TriggerOperation Enum
Type Class
UninstallHandler Interface
URL Class
UserInfo Class
UserManagement Class
Version Class
WebServiceCallout Class
WebServiceMock Interface
XmlStreamReader Class
XmlStreamWriter Class
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
wave Namespace
Appendices
Glossary
PDF

Newer Version Available

This content describes an older version of this product. View Latest

EncodingUtil Class

Use the methods in the EncodingUtil class to encode and decode URL strings, and convert strings to hexadecimal format.

Namespace

System

Usage

You cannot use the EncodingUtil methods to move documents with non-ASCII characters to Salesforce. You can, however, download a document from Salesforce. To do so, query the ID of the document using the API query call, then request it by ID.

Note

EncodingUtil Methods

The following are methods for EncodingUtil. All methods are static.

base64Decode(inputString)

Converts a Base64-encoded String to a Blob representing its normal form.

Signature

public static Blob base64Decode(String inputString)

Parameters

inputString
Type: String

Return Value

Type: Blob

base64Encode(inputBlob)

Converts a Blob to an unencoded String representing its normal form.

Signature

public static String base64Encode(Blob inputBlob)

Parameters

inputBlob
Type: Blob

Return Value

Type: String

convertFromHex(inputString)

Converts the specified hexadecimal (base 16) string to a Blob value and returns this Blob value.

Signature

public static Blob convertFromHex(String inputString)

Parameters

inputString
Type: String
The hexadecimal string to convert. The string can contain only valid hexadecimal characters (0-9, a-f, A-F) and must have an even number of characters.

Return Value

Type: Blob

Usage

Each byte in the Blob is constructed from two hexadecimal characters in the input string.

The convertFromHex method throws the following exceptions.

  • NullPointerException — the inputString is null.
  • InvalidParameterValueException — the inputString contains invalid hexadecimal characters or doesn’t contain an even number of characters.

Example

1Blob blobValue = EncodingUtil.convertFromHex('4A4B4C');
2System.assertEquals('JKL', blobValue.toString());

convertToHex(inputBlob)

Returns a hexadecimal (base 16) representation of the inputBlob. This method can be used to compute the client response (for example, HA1 or HA2) for HTTP Digest Authentication (RFC2617).

Signature

public static String convertToHex(Blob inputBlob)

Parameters

inputBlob
Type: Blob

Return Value

Type: String

urlDecode(inputString, encodingScheme)

Decodes a string in application/x-www-form-urlencoded format using a specific encoding scheme, for example “UTF-8.”

Signature

public static String urlDecode(String inputString, String encodingScheme)

Parameters

inputString
Type: String
encodingScheme
Type: String

Return Value

Type: String

Usage

This method uses the supplied encoding scheme to determine which characters are represented by any consecutive sequence of the from \"%xy\". For more information about the format, see The form-urlencoded Media Type in Hypertext Markup Language - 2.0.

urlEncode(inputString, encodingScheme)

Encodes a string into the application/x-www-form-urlencoded format using a specific encoding scheme, for example “UTF-8.”

Signature

public static String urlEncode(String inputString, String encodingScheme)

Parameters

inputString
Type: String
encodingScheme
Type: String

Return Value

Type: String

Usage

This method uses the supplied encoding scheme to obtain the bytes for unsafe characters. For more information about the format, see The form-urlencoded Media Type in Hypertext Markup Language - 2.0.

Example

1String encoded = EncodingUtil.urlEncode(url, 'UTF-8');