IPWorks Cloud 2020 JavaScript Edition

Questions / Feedback?

Prefix Property

A prefix used to restrict the results returned when listing files.

Syntax


 getPrefix(): string;

 setPrefix(prefix: string): void;

Default Value

""

Remarks

This property, if non-empty, is used to restrict the values returned by ListFiles, ListFileVersions, or ListMultipartUploads to only the items whose names begin with the given prefix.

Note: If the currently-authenticated application key is restricted to a specific file name prefix (indicated by the AccountAllowedPrefix property being non-empty), then this property will automatically be set to that prefix if it is empty when one of the aforementioned methods is called.

File Hierarchy Traversal

By using the Delimiter and Prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of files (or file versions) as if it were a filesystem. For example, assume that files with the following names exist within a bucket:

  • MyCompany
  • MyCompany/Department1
  • MyCompany/Department2
  • MyCompany/Department2/EmployeeA
  • MyCompany/Department2/EmployeeB

With Delimiter set to /, we can set Prefix to successively "deeper" values before calling ListFiles or ListFileVersions for the following effect:

Prefix Value Files Returned Folders Returned
(empty) MyCompany MyCompany/
MyCompany/ MyCompany/Department1
MyCompany/Department2
MyCompany/Department2/
MyCompany/Department2/ MyCompany/Department2/EmployeeA
MyCompany/Department2/EmployeeB
(none)

This property is not available at design time.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 JavaScript Edition - Version 20.0 [Build 8265]