AppKeyList Event

Fires once for each application key returned when listing application keys.

Syntax

• C#
• VB.NET

public event OnAppKeyListHandler OnAppKeyList;

public delegate void OnAppKeyListHandler(object sender, Backblazeb2AppKeyListEventArgs e);

public class Backblazeb2AppKeyListEventArgs : EventArgs {
  public string KeyId { get; }
  public string KeyName { get; }
  public string Capabilities { get; }
  public string AllowedBucketId { get; }
  public string AllowedPrefix { get; }
  public long ExpirationTime { get; }
}

Public Event OnAppKeyList As OnAppKeyListHandler

Public Delegate Sub OnAppKeyListHandler(sender As Object, e As Backblazeb2AppKeyListEventArgs)

Public Class Backblazeb2AppKeyListEventArgs Inherits EventArgs
  Public ReadOnly Property KeyId As String
  Public ReadOnly Property KeyName As String
  Public ReadOnly Property Capabilities As String
  Public ReadOnly Property AllowedBucketId As String
  Public ReadOnly Property AllowedPrefix As String
  Public ReadOnly Property ExpirationTime As Long
End Class

Remarks

This event fires once for each application key returned when ListAppKeys is called.

KeyId reflects the unique Id of the application key.

KeyName reflects the name that was given to the application key when it was created.

Capabilities reflects the capabilities that the application key has. It is formatted as a comma-separated list of one or more of the following:

AllowedBucketId reflects the Id of the bucket that the application key is restricted to. It will be empty if the application key is not restricted to any specific bucket.

AllowedPrefix reflects the file name prefix that the application key is restricted to. It will be empty if the application key is not restricted to a specific file name prefix.

ExpirationTime reflects the expiration time of the application key, in milliseconds relative to the Unix epoch. It will be -1 if the application key does not expire.