dw.sitemap
Class SitemapFile
dw.sitemap.SitemapFile
Instances of this class represent sitemap files located in the appservers shared file system. Methods are used to get
details of a sitemap file, such as the hostname it is associated with.
Properties
fileName
:
String
(Read Only)
The name of the file e.g. sitemap_index.xml
fileSize
:
Number
(Read Only)
The size of the file in bytes.
fileURL
:
String
(Read Only)
The URL used to access this file in a storefront request.
hostName
:
String
(Read Only)
The host name this file is associated with.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
getFileName()
:
String
Returns the name of the file e.g.
getFileSize()
:
Number
Returns the size of the file in bytes.
getFileURL()
:
String
Returns the URL used to access this file in a storefront request.
getHostName()
:
String
Returns the host name this file is associated with.
isValid()
:
boolean
Checks if this instance of sitemap file is valid.
Methods inherited from class
Object
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
Method Detail
getFileName
getFileName()
:
String
Returns the name of the file e.g. sitemap_index.xml
Returns:
The file's name, never
null.
getFileSize
getFileSize()
:
Number
Returns the size of the file in bytes.
Returns:
The fileSize in bytes.
getFileURL
getFileURL()
:
String
Returns the URL used to access this file in a storefront request.
Returns:
The fileURL, never
null.
getHostName
getHostName()
:
String
Returns the host name this file is associated with.
Returns:
The hostname, never
null.