IPWorks Cloud 2020 .NET Edition

Questions / Feedback?

FileList Event

Fires once for each file returned when listing files.

Syntax

public event OnFileListHandler OnFileList;

public delegate void OnFileListHandler(object sender, Backblazeb2FileListEventArgs e);

public class Backblazeb2FileListEventArgs : EventArgs {
  public string Id { get; }
  public string Name { get; }
  public string BucketId { get; }
  public long Size { get; }
  public string ContentType { get; }
  public long CreatedTime { get; }
  public long ModifiedTime { get; }
  public string Kind { get; }
  public string SHA1Hash { get; }
}
Public Event OnFileList As OnFileListHandler

Public Delegate Sub OnFileListHandler(sender As Object, e As Backblazeb2FileListEventArgs)

Public Class Backblazeb2FileListEventArgs Inherits EventArgs
  Public ReadOnly Property Id As String
  Public ReadOnly Property Name As String
  Public ReadOnly Property BucketId As String
  Public ReadOnly Property Size As Long
  Public ReadOnly Property ContentType As String
  Public ReadOnly Property CreatedTime As Long
  Public ReadOnly Property ModifiedTime As Long
  Public ReadOnly Property Kind As String
  Public ReadOnly Property SHA1Hash As String
End Class

Remarks

This event fires once for each file returned when ListFiles, ListFileVersions, or ListMultipartUploads is called.

Id reflects the Id of the file. Always empty when Kind is folder.

Name reflects the name of the file.

BucketId reflects the Id of the bucket that the file is in.

Size reflects the size of the file, in bytes. Always 0 when Kind is folder, hide, or start.

ContentType reflects the content type of the file. Always application/x-bz-hide-marker when Kind is hide; and empty when Kind is folder.

CreatedTime reflects the file's creation time, in milliseconds relative to the Unix epoch. Always 0 when Kind is folder.

ModifiedTime reflects the file's last modified time, in milliseconds relative to the Unix epoch. (Note that this parameter will only be populated if a src_last_modified_millis metadata item is included for the file, and if that metadata item's value can be parsed as a 64-bit integer; otherwise, it will be -1. Refer to the ClientModifiedTime configuration setting for more information.)

Kind reflects the file's kind. Possible values are:

folder A "folder" (only applicable when listing files with a Delimiter).
hide A hide marker file version created by HideFile.
start A multipart file upload that has not been completed or abandoned yet.
upload An file that has been uploaded (either directly, or via a multipart upload).

SHA1Hash reflects a hex-encoded SHA1 hash of the file's contents, or empty string if such a hash is not available. Always empty when Kind is folder or hide.

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