Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
commonserviceexcellence Namespace
ComplianceMgmt Namespace
Compression Namespace
Level Enum
Method Enum
ZipEntry Class
ZipReader Class
ZipWriter Class
ZipWriter Constructors
ZipWriter Methods
Compression Exceptions
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
disputemanagement Namespace
fsccashflow Namespace
fsccomplaintmanagement Namespace
fschousehold Namespace
fscserviceprocesses Namespace
fscwmgen Namespace
industriespersonalizedfinance Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
renew_assets_summary Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
Search Namespace
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
sfdw Namespace
sfsqlquery Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

ZipWriter Class

Contains methods to add zip entries, generate a zipped archive, and return the result as an Apex blob.

Namespace

Compression

Example

This sample code compresses email attachments into a single file.

1Compression.ZipWriter writer = new Compression.ZipWriter();
2
3List<id> contentDocumentIds = new List<id>();
4
5// Add IDs of documents to be compressed to contentDocumentIds 
6
7for ( ContentVersion cv : [SELECT PathOnClient, Versiondata
8                           FROM ContentVersion
9                           WHERE ContentDocumentId IN :contentDocumentIds]) 
10{
11      writer.addEntry(cv.PathOnClient, cv.versiondata);
12}
13
14blob zipAttachment = writer.getArchive();
15
16Messaging.EmailFileAttachment efa = new Messaging.EmailFileAttachment();
17efa.setFileName('attachments.zip');
18efa.setBody(zipAttachment);
19
20List<Messaging.EmailFileAttachment> fileAttachments = new List<Messaging.EmailFileAttachment>();
21fileAttachments.add(efa);
22
23Messaging.SingleEmailMessage email = new Messaging.SingleEmailMessage();
24
25// Set all the other email fields, such as addresses, subject, and body
26
27email.setFileAttachments(fileAttachments);
28
29Messaging.sendEmail(new Messaging.SingleEmailMessage[] { email });  
30

ZipWriter Constructors

The following are constructors for ZipWriter.

ZipWriter()

Creates a new instance of the ZipWriter class.

Signature

global ZipWriter()

ZipWriter Methods

The following are methods for ZipWriter.

addEntry(name, data)

Adds an entry to the zip file with the specified name and content.

Signature

public Compression.ZipEntry addEntry(string name, blob data)

Parameters

  • name: Type: string The name of the zip entry.
  • data: Type: blob The content of the zip entry.

Return Value

Type: Compression.ZipEntry

Zip entry added to the zip file.

addEntry(prototype)

Adds a copy of the specified prototype entry to the zip file and includes details such as the zip entry name, comment, last modification time, and content.

Signature

public Compression.ZipEntry addEntry(compression.ZipEntry prototype)

Parameters

Return Value

Type: Compression.ZipEntry

addEntry(name, comment, modTime, method, data)

Adds an entry to the zip file with the specified name, comment, last modification time, compression method, and content.

Signature

public Compression.ZipEntry addEntry(String name, String comment, Datetime modTime, Compression.Method method, Blob data)

Parameters

  • name: Type: String The name of the zip entry.
  • comment: Type: String The comment about the zip entry.
  • modTime: Type: Datetime The last modification timestamp of the zip entry.
  • method: Type: Compression.Method The compression method of the zip entry, which is either DEFLATED or STORED.
  • data: Type: Blob The content of the zip entry.

Return Value

Type: Compression.ZipEntry

Zip entry added to the zip file.

getArchive()

Compresses the zip entries and generates a ZIP archive.

Signature

public blob getArchive()

Return Value

Type: blob

Apex blob that contains the bytes of the compression operation.

getEntries()

Gets a list of all the entries in the zip file.

Signature

public List<Compression.ZipEntry> getEntries()

Return Value

Type: List<Compression.ZipEntry>

getEntry(name)

Gets the entry with the specified name from the zip file.

Signature

public compression.ZipEntry getEntry(string name)

Parameters

  • name: Type: string Name of the zip entry to be retrieved.

Return Value

Type: Compression.ZipEntry

getEntryNames()

Gets a set of all the zip entry names in the zip file.

Signature

public Set<String> getEntryNames()

Return Value

Type: Set<String>

getLevel()

Gets the compression level of the zip file.

Signature

public Compression.Level getLevel()

Return Value

Type: Compression.Level

Uses the Level enum values to indicate the compression level as BEST_COMPRESSION, BEST_SPEED, DEFAULT_LEVEL, or NO_COMPRESSION.

getMethod()

Gets the compression method of the zip file.

Signature

public Compression.Method getMethod()

Return Value

Type: Compression.Method

Uses the Method enum values to indicate the compression method as DEFLATED or STORED.

removeEntry(name)

Removes the entry with the specified name from the zip file.

Signature

public Void removeEntry(string name)

Parameters

  • name: Type: string Name of the zip entry to be removed. If an entry with this name isn’t found, the method throws a ZipException exception.

Return Value

Type: Void

setLevel(level)

Sets the compression level of the zip file.

Signature

public Compression.ZipWriter setLevel(compression.Level value)

Parameters

Return Value

Type: Compression.ZipWriter

Returns the zip file set with the specified compression level.

setMethod(method)

Sets the compression method for the zip file.

Signature

public Compression.ZipWriter setMethod(compression.Method value)

Parameters

Return Value

Type: Compression.ZipWriter

Returns the zip file set with the specified compression method.