@chilkat/react-native 11.6.1

package/src/specs/SFtpDir.nitro.ts

@@ -0,0 +1,213 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { SFtpFile } from './SFtpFile.nitro'
+
+/**
+ * Inspect, sort, and iterate an SFTP directory listing.
+ *
+ * `SFtpDir` represents a directory listing returned by an
+ * SFTP operation. It provides the original path used to fetch the listing, the
+ * number of files and subdirectories found, methods for retrieving filenames
+ * or full `SFtpFile` entry details by index, sorting support, and a
+ * way to load a completed asynchronous directory-listing result.
+ *
+ * **Directory listing object**
+ *
+ * Holds the files and subdirectories returned from an SFTP directory-read
+ * operation.
+ *
+ * **Original path tracking**
+ *
+ * Use `OriginalPath` to see the remote path that was requested
+ * when the directory listing was created.
+ *
+ * **Entry count**
+ *
+ * Read `NumFilesAndDirs` to determine how many directory
+ * entries are available for iteration.
+ *
+ * **Filename access**
+ *
+ * Use `GetFilename` to retrieve the name of an entry by
+ * zero-based index.
+ *
+ * **Full entry details**
+ *
+ * Use `FileAt` to populate an `SFtpFile` object with
+ * metadata for a selected file or subdirectory.
+ *
+ * **Sorting and async results**
+ *
+ * Sort entries by filename, timestamps, or size, and load directory
+ * listings returned from completed async tasks.
+ *
+ * **Common pattern:**
+ * Use a `Chilkat.SFtp` object to open or read a remote directory,
+ * then use the returned `SFtpDir` object to inspect
+ * `NumFilesAndDirs`, optionally call `Sort`, and loop
+ * from index `0` through the final entry. Use
+ * `GetFilename` when only names are needed, or `FileAt`
+ * when the application needs the full `SFtpFile` metadata for each
+ * entry.
+ *
+ * Each `SFtpDir` instance owns a native Chilkat object. It is released when the JavaScript object
+ * is
+ * garbage collected, or immediately by `dispose()`; any use after `dispose()` throws.
+ * Create one with `new SFtpDir()`.
+ */
+export interface SFtpDir extends HybridObject<{ ios: 'c++', android: 'c++' }> {
+  // ---- Properties ----
+
+  /**
+   * Provides HTML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorHtml: string
+
+  /**
+   * Provides plain text information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorText: string
+
+  /**
+   * Provides XML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorXml: string
+
+  /**
+   * Version of the component/library, such as "10.1.0"
+   *
+   * This property is read-only.
+   */
+  readonly version: string
+
+  /**
+   * If set to a file path, this property logs the LastErrorText of each Chilkat method or property
+   * call to the specified file. This logging helps identify the context and history of Chilkat
+   * calls leading up to any crash or hang, aiding in debugging.
+   *
+   * Enabling the VerboseLogging property provides more detailed information.
+   *
+   * This property is mainly used for debugging rare instances where a Chilkat method call causes a
+   * hang or crash, which should generally not happen.
+   *
+   * Possible causes of hangs include:
+   *
+   * - A timeout property set to 0, indicating an infinite timeout.
+   *
+   * - A hang occurring within an event callback in the application code.
+   *
+   * - An internal bug in the Chilkat code causing the hang.
+   */
+  debugLogFilePath: string
+
+  /**
+   * If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may
+   * contain more verbose information. The default value is `false`. Verbose logging should only be
+   * used for debugging. The potentially large quantity of logged information may adversely affect
+   * peformance.
+   */
+  verboseLogging: boolean
+
+  /**
+   * Indicates the success or failure of the most recent method call: `true` means success, `false`
+   * means failure. This property remains unchanged by property setters or getters. This method is
+   * present to address challenges in checking for null or Nothing returns in certain programming
+   * languages. Note: This property does not apply to methods that return integer values or to
+   * boolean-returning methods where the boolean does not indicate success or failure.
+   */
+  lastMethodSuccess: boolean
+
+  /**
+   * Returns the number of entries in this directory listing.
+   *
+   * The count includes every item returned by the server, such as regular files, directories,
+   * symbolic links, and special entries. Valid zero-based indexes range from `0` through
+   * `NumFilesAndDirs - 1`.
+   *
+   * This property is read-only.
+   */
+  readonly numFilesAndDirs: number
+
+  /**
+   * Returns the original remote path used to create this directory listing.
+   *
+   * This is the same path string that was supplied to the SFTP directory-open operation. It
+   * identifies the requested directory and is retained with the listing for later reference.
+   *
+   * This property is read-only.
+   */
+  readonly originalPath: string
+
+  // ---- Methods ----
+
+  /**
+   * Returns the filename of the directory entry at the zero-based `index`.
+   *
+   * The first entry is at index `0`. Use {@link SFtpDir.numFilesAndDirs} to determine the number of
+   * available entries.
+   *
+   * Use {@link SFtpDir.fileAt} when the application needs the full `SFtpFile` metadata rather than
+   * only the entry name.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link SFtpDir.lastErrorText}.
+   */
+  getFilename(index: number): string
+
+  /**
+   * Reorders the files and subdirectories in this listing according to `field`.
+   *
+   * Set `ascending` to `true` for ascending order or `false` for descending order. The new order is
+   * used by index-based methods such as {@link SFtpDir.getFilename} and {@link SFtpDir.fileAt}.
+   *
+   * field
+   * Sort key
+   *
+   * | `filename` |
+   * | Filename using the normal case-sensitive comparison. |
+   *
+   * | `filenameNoCase` |
+   * | Filename using a case-insensitive comparison. |
+   *
+   * | `lastModifiedTime` |
+   * | Last-modified date and time. |
+   *
+   * | `lastAccessTime` |
+   * | Last-access date and time. |
+   *
+   * | `lastCreateTime` |
+   * | Creation date and time. |
+   *
+   * | `size` |
+   * | Entry size in bytes. |
+   */
+  sort(field: string, ascending: boolean): void
+
+  /**
+   * Copies the metadata for the directory entry at the zero-based `index` into `fileObj`.
+   *
+   * The first entry is at index `0`. Use {@link SFtpDir.numFilesAndDirs} to determine the number of
+   * available entries.
+   *
+   * The populated `SFtpFile` object provides the entry name, type, size, timestamps, ownership,
+   * permissions, and any additional attributes supplied by the SFTP server.
+   *
+   * Use {@link SFtpDir.getFilename} when only the entry name is needed.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link SFtpDir.lastErrorText}.
+   */
+  fileAt(index: number, fileObj: SFtpFile): void
+}

package/src/specs/SFtpFile.nitro.ts

@@ -0,0 +1,452 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+
+/**
+ * Inspect metadata for a file, directory, symlink, or special item in an SFTP listing.
+ *
+ * `SFtpFile` represents one entry returned from an SFTP
+ * directory listing. It exposes the entry name, file type, size, ownership,
+ * permissions, timestamps, and server-provided attribute flags such as hidden,
+ * read-only, archive, immutable, encrypted, compressed, sparse, append-only,
+ * system, and synchronization status. It is typically used together with
+ * `Chilkat.SFtpDir` when iterating a remote directory and deciding
+ * how each entry should be displayed, filtered, downloaded, skipped, or
+ * processed.
+ *
+ * **Name and type**
+ *
+ * Read `Filename` and `FileType`, or use convenience
+ * flags such as `IsRegular`, `IsDirectory`, and
+ * `IsSymLink`.
+ *
+ * **File sizes**
+ *
+ * Access the entry size as a 32-bit integer, 64-bit integer, or decimal
+ * string using `Size32`, `Size64`, or
+ * `SizeStr`.
+ *
+ * **Timestamps**
+ *
+ * Inspect creation, last-access, and last-modified times as date/time
+ * values or RFC822-formatted strings when supported by the server.
+ *
+ * **Ownership**
+ *
+ * Read numeric user and group IDs, and when the server supports it, textual
+ * owner and group names.
+ *
+ * **Permissions**
+ *
+ * Inspect the POSIX-style permissions bit mask for read, write, execute,
+ * set-user-ID, set-group-ID, and sticky-bit information.
+ *
+ * **Extended attributes**
+ *
+ * Check server-provided flags such as hidden, read-only, archive,
+ * immutable, encrypted, compressed, sparse, append-only, system, and sync.
+ *
+ * **Common pattern:**
+ * Retrieve a directory listing with `Chilkat.SFtp`, iterate its
+ * `Chilkat.SFtpDir` entries, and populate a
+ * `SFtpFile` object for each item. Use the file type,
+ * timestamps, size, permissions, and attribute flags to decide whether the
+ * entry is a regular file, directory, symlink, or special item and how the
+ * application should handle it.
+ *
+ * **Server-version note:**
+ * Some metadata is only available from newer SFTP protocol versions. For
+ * example, textual owner/group information and creation time require SFTP v4
+ * or later, while many extended attribute flags such as read-only, archive,
+ * immutable, compressed, encrypted, sparse, append-only, and system require
+ * SFTP v6 or later.
+ *
+ * Each `SFtpFile` instance owns a native Chilkat object. It is released when the JavaScript object
+ * is
+ * garbage collected, or immediately by `dispose()`; any use after `dispose()` throws.
+ * Create one with `new SFtpFile()`.
+ */
+export interface SFtpFile extends HybridObject<{ ios: 'c++', android: 'c++' }> {
+  // ---- Properties ----
+
+  /**
+   * Provides HTML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorHtml: string
+
+  /**
+   * Provides plain text information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorText: string
+
+  /**
+   * Provides XML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorXml: string
+
+  /**
+   * Version of the component/library, such as "10.1.0"
+   *
+   * This property is read-only.
+   */
+  readonly version: string
+
+  /**
+   * If set to a file path, this property logs the LastErrorText of each Chilkat method or property
+   * call to the specified file. This logging helps identify the context and history of Chilkat
+   * calls leading up to any crash or hang, aiding in debugging.
+   *
+   * Enabling the VerboseLogging property provides more detailed information.
+   *
+   * This property is mainly used for debugging rare instances where a Chilkat method call causes a
+   * hang or crash, which should generally not happen.
+   *
+   * Possible causes of hangs include:
+   *
+   * - A timeout property set to 0, indicating an infinite timeout.
+   *
+   * - A hang occurring within an event callback in the application code.
+   *
+   * - An internal bug in the Chilkat code causing the hang.
+   */
+  debugLogFilePath: string
+
+  /**
+   * If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may
+   * contain more verbose information. The default value is `false`. Verbose logging should only be
+   * used for debugging. The potentially large quantity of logged information may adversely affect
+   * peformance.
+   */
+  verboseLogging: boolean
+
+  /**
+   * Indicates the success or failure of the most recent method call: `true` means success, `false`
+   * means failure. This property remains unchanged by property setters or getters. This method is
+   * present to address challenges in checking for null or Nothing returns in certain programming
+   * languages. Note: This property does not apply to methods that return integer values or to
+   * boolean-returning methods where the boolean does not indicate success or failure.
+   */
+  lastMethodSuccess: boolean
+
+  /**
+   * Returns the file creation date and time as an RFC 822-formatted string, such as `Fri, 21 Nov
+   * 1997 09:55:06 -0600`.
+   *
+   * **Server requirement:** Creation-time metadata is available only when the server supports SFTP
+   * version 4 or later and provides this attribute.
+   *
+   * This property is read-only.
+   */
+  readonly createTimeStr: string
+
+  /**
+   * Identifies the type of directory entry. The returned value is one of the following:
+   *
+   * Value
+   * Meaning
+   *
+   * | `regular` |  | A regular file. |
+   *
+   * | `directory` |  | A directory. |
+   *
+   * | `symLink` |  | A symbolic link. |
+   *
+   * | `special` |  | A special file whose more specific type is not reported. |
+   *
+   * | `unknown` |  | The type is unknown or was not provided by the server. |
+   *
+   * | `socket` |  | A socket. |
+   *
+   * | `charDevice` |  | A character device. |
+   *
+   * | `blockDevice` |  | A block device. |
+   *
+   * | `fifo` |  | A FIFO (named pipe). |
+   *
+   * The convenience properties {@link SFtpFile.isRegular}, {@link SFtpFile.isDirectory}, and {@link
+   * SFtpFile.isSymLink} may be used for the most common entry types.
+   *
+   * This property is read-only.
+   */
+  readonly fileType: string
+
+  /**
+   * Returns the name of the directory entry. Depending on the entry type, this may be a regular
+   * filename, directory name, symbolic-link name, or the name of another special filesystem object.
+   *
+   * This property is read-only.
+   */
+  readonly filename: string
+
+  /**
+   * Returns the numeric group ID associated with the file.
+   *
+   * This property is read-only.
+   */
+  readonly gid: number
+
+  /**
+   * Returns the textual group name associated with the file.
+   *
+   * **Server requirement:** This attribute is available only when the server supports SFTP version
+   * 4 or later and provides owner/group names.
+   *
+   * This property is read-only.
+   */
+  readonly group: string
+
+  /**
+   * Returns `true` if the server marks the file as append-only. New data may be added only at the
+   * end of the file; existing data cannot be overwritten through normal file writes.
+   *
+   * **Server requirement:** This attribute is defined for SFTP version 6 or later.
+   *
+   * This property is read-only.
+   */
+  readonly isAppendOnly: boolean
+
+  /**
+   * Returns `true` if the server marks the file for inclusion in backup or archive operations.
+   *
+   * **Server requirement:** This attribute is defined for SFTP version 6 or later.
+   *
+   * This property is read-only.
+   */
+  readonly isArchive: boolean
+
+  /**
+   * Applies to directories. Returns `true` when names within the directory should be compared
+   * without regard to letter case.
+   *
+   * **Server requirement:** This attribute is defined for SFTP version 6 or later.
+   *
+   * This property is read-only.
+   */
+  readonly isCaseInsensitive: boolean
+
+  /**
+   * Returns `true` if the file is stored using transparent filesystem-level compression on the
+   * server.
+   *
+   * This attribute describes how the server stores the file. It does not change the file bytes
+   * transferred through SFTP.
+   *
+   * **Server requirement:** This attribute is defined for SFTP version 6 or later.
+   *
+   * This property is read-only.
+   */
+  readonly isCompressed: boolean
+
+  /**
+   * Returns `true` if the directory entry is a directory.
+   *
+   * This property is read-only.
+   */
+  readonly isDirectory: boolean
+
+  /**
+   * Returns `true` if the file is stored using transparent filesystem-level encryption on the
+   * server.
+   *
+   * This attribute describes storage at rest. It does not alter the file bytes returned by read
+   * operations or accepted by write operations.
+   *
+   * **Server requirement:** This attribute is defined for SFTP version 6 or later.
+   *
+   * This property is read-only.
+   */
+  readonly isEncrypted: boolean
+
+  /**
+   * Returns `true` if the server marks the entry as hidden. Hidden entries are normally omitted
+   * from user-facing displays unless the user specifically requests them.
+   *
+   * This property is read-only.
+   */
+  readonly isHidden: boolean
+
+  /**
+   * Returns `true` if the server marks the file as immutable. An immutable file cannot normally be
+   * deleted, renamed, modified, or used as the target of a new hard link.
+   *
+   * Immutability is generally stronger than read-only status, the ordinary permission mask, or an
+   * access-control list. On many systems, only a privileged administrator can set or clear this
+   * attribute.
+   *
+   * **Server requirement:** This attribute is defined for SFTP version 6 or later.
+   *
+   * This property is read-only.
+   */
+  readonly isImmutable: boolean
+
+  /**
+   * Returns `true` if the server marks the file as read-only.
+   *
+   * **Server requirement:** This attribute is defined for SFTP version 6 or later.
+   *
+   * This property is read-only.
+   */
+  readonly isReadOnly: boolean
+
+  /**
+   * Returns `true` if the directory entry is a regular file rather than a directory, symbolic link,
+   * device, socket, FIFO, or other special type.
+   *
+   * This property is read-only.
+   */
+  readonly isRegular: boolean
+
+  /**
+   * Returns `true` if the server identifies the file as sparse. A sparse file can contain unwritten
+   * regions, often called holes, that read as zero bytes without consuming equivalent physical disk
+   * space.
+   *
+   * For example, writing data at an offset of 10 MB may leave the region between the previous end
+   * of file and that offset unallocated on disk.
+   *
+   * Some servers store all files sparsely and may always set this flag. Other servers cannot
+   * reliably determine whether a file is sparse, so a file may be sparse even when this property is
+   * `false`.
+   *
+   * **Server requirement:** This attribute is defined for SFTP version 6 or later.
+   *
+   * This property is read-only.
+   */
+  readonly isSparse: boolean
+
+  /**
+   * Returns `true` if the directory entry is a symbolic link.
+   *
+   * This property is read-only.
+   */
+  readonly isSymLink: boolean
+
+  /**
+   * Returns `true` if modifications to the file are committed synchronously to server storage.
+   *
+   * **Server requirement:** This attribute is defined for SFTP version 6 or later.
+   *
+   * This property is read-only.
+   */
+  readonly isSync: boolean
+
+  /**
+   * Returns `true` if the server marks the file as part of the operating system.
+   *
+   * **Server requirement:** This attribute is defined for SFTP version 6 or later.
+   *
+   * This property is read-only.
+   */
+  readonly isSystem: boolean
+
+  /**
+   * Returns the file's last-access date and time as an RFC 822-formatted string, such as `Fri, 21
+   * Nov 1997 09:55:06 -0600`.
+   *
+   * This property is read-only.
+   */
+  readonly lastAccessTimeStr: string
+
+  /**
+   * Returns the file's last-modified date and time as an RFC 822-formatted string, such as `Fri, 21
+   * Nov 1997 09:55:06 -0600`.
+   *
+   * Use `LastModifiedTime` when a native date/time value is more convenient.
+   *
+   * This property is read-only.
+   */
+  readonly lastModifiedTimeStr: string
+
+  /**
+   * Returns the textual owner name associated with the file.
+   *
+   * **Server requirement:** This attribute is available only when the server supports SFTP version
+   * 4 or later and provides owner/group names.
+   *
+   * This property is read-only.
+   */
+  readonly owner: string
+
+  /**
+   * Returns the POSIX-style file-permission bit mask. The values correspond to the permission and
+   * special-mode bits in the POSIX `st_mode` field.
+   *
+   * Symbol
+   * Octal value
+   * Meaning
+   *
+   * | `S_IRUSR` |  | `0400` |  | Owner read |
+   *
+   * | `S_IWUSR` |  | `0200` |  | Owner write |
+   *
+   * | `S_IXUSR` |  | `0100` |  | Owner execute |
+   *
+   * | `S_IRGRP` |  | `0040` |  | Group read |
+   *
+   * | `S_IWGRP` |  | `0020` |  | Group write |
+   *
+   * | `S_IXGRP` |  | `0010` |  | Group execute |
+   *
+   * | `S_IROTH` |  | `0004` |  | Others read |
+   *
+   * | `S_IWOTH` |  | `0002` |  | Others write |
+   *
+   * | `S_IXOTH` |  | `0001` |  | Others execute |
+   *
+   * | `S_ISUID` |  | `4000` |  | Set-user-ID |
+   *
+   * | `S_ISGID` |  | `2000` |  | Set-group-ID |
+   *
+   * | `S_ISVTX` |  | `1000` |  | Sticky bit |
+   *
+   * Use bitwise AND operations to test individual permission bits.
+   *
+   * This property is read-only.
+   */
+  readonly permissions: number
+
+  /**
+   * Returns the file size in bytes as a 32-bit integer. Returns `-1` when the size cannot be
+   * represented by a 32-bit integer. Use {@link SFtpFile.size64} or {@link SFtpFile.sizeStr} for
+   * larger values.
+   *
+   * This property is read-only.
+   */
+  readonly size32: number
+
+  /**
+   * Returns the file size in bytes as a 64-bit integer.
+   *
+   * This property is read-only.
+   *
+   * A 64-bit integer in Chilkat; JavaScript numbers are exact up to 2^53.
+   */
+  readonly size64: number
+
+  /**
+   * Returns the file size in bytes as a base-10 string. This is the string representation of {@link
+   * SFtpFile.size64} and is useful in environments where a 64-bit integer is inconvenient or
+   * unavailable.
+   *
+   * This property is read-only.
+   */
+  readonly sizeStr: string
+
+  /**
+   * Returns the numeric user ID associated with the file.
+   *
+   * This property is read-only.
+   */
+  readonly uid: number
+}