Class 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.
| Property | Description |
|---|---|
fileName: String (read-only) | Returns the name of the file e.g. |
fileSize: Number (read-only) | Returns the size of the file in bytes. |
fileURL: String (read-only) | Returns the URL used to access this file in a storefront request. |
hostName: String (read-only) | Returns the host name this file is associated with. |
valid: Boolean (read-only) | Checks if this instance of sitemap file is valid. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| getFileName() | Returns the name of the file e.g. |
| getFileSize() | Returns the size of the file in bytes. |
| getFileURL() | Returns the URL used to access this file in a storefront request. |
| getHostName() | Returns the host name this file is associated with. |
| isValid() | Checks if this instance of sitemap file is valid. |
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
- fileName: String
(read-only) Returns the name of the file e.g. sitemap_index.xml
- fileSize: Number
(read-only) Returns the size of the file in bytes.
- fileURL: String
(read-only) Returns the URL used to access this file in a storefront request.
- hostName: String
(read-only) Returns the host name this file is associated with.
- valid: Boolean
(read-only) Checks if this instance of sitemap file is valid. Examples for invalid files are:
- file size >10mb
Additional violations might be added later.
- getFileName(): String
Returns the name of the file e.g. sitemap_index.xml
Returns:
- The file's name, never
null.
- The file's name, never
- getFileSize(): Number
Returns the size of the file in bytes.
Returns:
- The fileSize in bytes.
- getFileURL(): String
Returns the URL used to access this file in a storefront request.
Returns:
- The fileURL, never
null.
- The fileURL, never
- getHostName(): String
Returns the host name this file is associated with.
Returns:
- The hostname, never
null.
- The hostname, never
- isValid(): Boolean
Checks if this instance of sitemap file is valid. Examples for invalid files are:
- file size >10mb
Additional violations might be added later.
Returns:
trueif theSitemapFileis valid,falseotherwise.