AuthAzureStorage React Native Reference Documentation

AuthAzureStorage

Current Version: 11.6.1

Chilkat.AuthAzureStorage

Authenticate Azure Storage REST requests with account-key Shared Key signing.

Chilkat.AuthAzureStorage is a credential object for Azure Storage Services authentication. It stores the storage account name, Base64 account access key, Azure Storage service type, authentication scheme, and x-ms-version API version used when signing REST requests for Blob, Queue, File, or Table storage.

Azure Storage credentials

Hold the storage account name and Base64 account access key used to sign Azure Storage REST requests.

Shared Key signing

Configure Azure Storage authentication using SharedKey or SharedKeyLite, depending on the service and request style.

Service targeting

Specify the Azure Storage service being accessed, such as Blob, Queue, File, or Table.

API version header

Set the x-ms-version value required by the Azure Storage REST API version being used.

REST integration

Use the configured object with Chilkat.Rest so requests are signed automatically before being sent.

Low-level control

Pair this authentication object with manually constructed REST requests when application code needs direct control over Azure Storage operations.

Common pattern: Create an AuthAzureStorage object, set the storage Account, Base64 AccessKey, Service, Scheme, and XMsVersion, then attach it to a Chilkat.Rest request workflow. Use AuthAzureStorage for Shared Key authorization headers; use Chilkat.AuthAzureSAS when the request should be authorized with a SAS query token instead.

Object Creation

// npm install @chilkat/react-native react-native-nitro-modules
// (React Native 0.76+ with the New Architecture; then `pod install` for iOS.  The Chilkat
//  native library is downloaded and verified during the native build -- see the package README.)

import { Chilkat, AuthAzureStorage } from '@chilkat/react-native'

// Once per app start, before any other Chilkat call:
Chilkat.unlockBundle('Anything for 30-day trial')   // shorthand for new Global().unlockBundle(..)

const authAzureStorage = new AuthAzureStorage()
// ... the native object is released when `authAzureStorage` is garbage collected, or now with authAzureStorage.dispose()
new AuthAzureStorage()

Creates the underlying native Chilkat object. AuthAzureStorage is a Nitro Module HybridObject: use it from the JavaScript thread only (it cannot be passed to a Worklet or another runtime). Every member is synchronous and blocks the JavaScript thread until Chilkat returns; a method that can take a while also exists as a ...Async twin returning a Promise, which runs the same call on a native worker thread so the UI keeps rendering. While such a call is pending, every other call on this object throws, except abort() and assigning onPercentDone / onProgressInfo.

dispose(): void

Releases the native object immediately instead of waiting for garbage collection (useful for a large BinData or an open socket). Calling it more than once is harmless; any other use of the object afterwards throws. An object with a pending ...Async call cannot be disposed until the promise settles.

Errors

A method that can fail throws a plain Error: a method whose only outcome is success or failure returns void and throws on failure; a method producing a string or an object returns it and throws where Chilkat would have returned null. The error's message is "Class.method(...): reason", where the reason is the last informative line of the object's lastErrorText, which holds the full Chilkat log of the failed call. A ...Async twin rejects its promise with the same Error instead of throwing. Properties never throw, and methods that answer a question (has..., is..., ...) return a plain boolean.

try {
  authAzureStorage.someMethod(...)
} catch (e) {
  console.log((e as Error).message)   // AuthAzureStorage.someMethod(...): <reason>
  console.log(authAzureStorage.lastErrorText)   // the full Chilkat log of the failed call
}

// The same call without blocking the JavaScript thread:
try {
  await authAzureStorage.someMethodAsync(...)
} catch (e) {
  console.log((e as Error).message)   // AuthAzureStorage.someMethodAsync: <reason>
}

Properties

AccessKey
// read/write
accessKey: string
Introduced in version 9.5.0.58

A valid base64 access key for the Azure storage account.

More Information and Examples
top
Account
// read/write
account: string
Introduced in version 9.5.0.58

The Azure storage account name. (A storage account can contain zero or more containers. A container contains properties, metadata, and zero or more blobs. A blob is any single entity comprised of binary data, properties, and metadata. )

top
DebugLogFilePath
// read/write
debugLogFilePath: 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.

More Information and Examples
top
LastErrorHtml
// read-only
readonly lastErrorHtml: string

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.

top
LastErrorText
// read-only
readonly lastErrorText: 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.

top
LastErrorXml
// read-only
readonly lastErrorXml: 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.

top
LastMethodSuccess
// read/write
lastMethodSuccess: 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.

top
Scheme
// read/write
scheme: string
Introduced in version 9.5.0.58

Can be SharedKey or SharedKeyLite. The default value is SharedKey.

top
Service
// read/write
service: string
Introduced in version 9.5.0.58

Can be Blob, Queue, File, or Table. The default is Blob.

Note: Authentication for the Table service did not work in versions prior to v9.5.0.83.

top
VerboseLogging
// read/write
verboseLogging: boolean

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.

top
Version
// read-only
readonly version: string

Version of the component/library, such as "10.1.0"

More Information and Examples
top
XMsVersion
// read/write
xMsVersion: string
Introduced in version 9.5.0.58

If set, automatically adds the x-ms-version HTTP request header to Azure Storage requests. The default value is 2014-02-14.

top

Methods