AZSCloudBlob Class Reference

Inherits from NSObject
Declared in AZSCloudBlob.h
AZSCloudBlob.m

Overview

The AZSCloudBlob represents a blob in Azure Storage.

The AZSCloudBlob is used to perform blob-level operations on all blobs, including retrieving, and deleting.

  blobName

The name of the blob. This is the full path to the blob, not including the container name.

@property (copy) NSString *blobName

Discussion

The name of the blob. This is the full path to the blob, not including the container name.

Declared In

AZSCloudBlob.h

  blobContainer

The container in which this blob exists.

@property (strong) AZSCloudBlobContainer *blobContainer

Discussion

The container in which this blob exists.

Declared In

AZSCloudBlob.h

  storageUri

The full StorageURI to this blob.

@property (strong) AZSStorageUri *storageUri

Discussion

The full StorageURI to this blob.

Declared In

AZSCloudBlob.h

  client

The blob client representing the blob service for this blob.

@property (strong) AZSCloudBlobClient *client

Discussion

The blob client representing the blob service for this blob.

Declared In

AZSCloudBlob.h

  snapshotTime

The snapshot time of this snapshot of the blob. If nil, this AZSCloudBlob object does not represent a snapshot.

@property (copy, AZSNullable) NSString *snapshotTime

Discussion

The snapshot time of this snapshot of the blob. If nil, this AZSCloudBlob object does not represent a snapshot.

Declared In

AZSCloudBlob.h

  metadata

The metadata on this blob.

@property (strong) NSMutableDictionary *metadata

Discussion

The metadata on this blob.

Declared In

AZSCloudBlob.h

  properties

The properties on this blob.

@property (strong) AZSBlobProperties *properties

Discussion

The properties on this blob.

Declared In

AZSCloudBlob.h

  blobCopyState

The current copy state of this blob.

@property (strong) AZSCopyState *blobCopyState

Discussion

The current copy state of this blob.

Declared In

AZSCloudBlob.h

– downloadToStream:completionHandler:

Downloads the contents of the blob to a stream.

- (void)downloadToStream:(NSOutputStream *)targetStream completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

targetStream

The destination stream. The stream should already be opened.
completionHandler

The block of code to execute when the download call completes. Note that this will only be called after the entire blob has been downloaded.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Downloads the contents of the blob to a stream.

This method streams the contents of a blob down from the service.

Declared In

AZSCloudBlob.h

– downloadToStream:accessCondition:requestOptions:operationContext:completionHandler:

Downloads the contents of the blob to a stream.

- (void)downloadToStream:(NSOutputStream *)targetStream accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

targetStream

The destination stream. The stream should already be opened.
accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the download call completes. Note that this will only be called after the entire blob has been downloaded.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Downloads the contents of the blob to a stream.

This method streams the contents of a blob down from the service.

Declared In

AZSCloudBlob.h

– downloadToStream:range:accessCondition:requestOptions:operationContext:completionHandler:

Downloads the contents of the blob to a stream.

- (void)downloadToStream:(NSOutputStream *)targetStream range:(NSRange)range accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

targetStream

The destination stream. The stream should already be opened.
range

The range of bytes to download. If the length is 0, download the entire blob.
accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the download call completes. Note that this will only be called after the entire blob has been downloaded.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Downloads the contents of the blob to a stream.

This method streams the contents of a blob down from the service.

Declared In

AZSCloudBlob.h

– downloadToStream:AZSULLrange:accessCondition:requestOptions:operationContext:completionHandler:

Downloads the contents of the blob to a stream.

- (void)downloadToStream:(NSOutputStream *)targetStream AZSULLrange:(AZSULLRange)range accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

targetStream

The destination stream. The stream should already be opened.
range

The range of bytes to download. If the length is 0, download the entire blob.
accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the download call completes. Note that this will only be called after the entire blob has been downloaded.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Downloads the contents of the blob to a stream.

This method streams the contents of a blob down from the service.

Declared In

AZSCloudBlob.h

– deleteWithCompletionHandler:

Deletes the blob.

- (void)deleteWithCompletionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

completionHandler

The block of code to execute when the delete call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Deletes the blob.

This method deletes the blob on the service. It will fail if the blob does not exist.

Declared In

AZSCloudBlob.h

– deleteWithSnapshotsOption:completionHandler:

Deletes the blob.

- (void)deleteWithSnapshotsOption:(AZSDeleteSnapshotsOption)snapshotsOption completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

snapshotsOption

If snapshots should be deleted. See AZSDeleteSnapshotsOption for more information.
completionHandler

The block of code to execute when the delete call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Deletes the blob.

This method deletes the blob on the service. It will fail if the blob does not exist.

Declared In

AZSCloudBlob.h

– deleteWithSnapshotsOption:accessCondition:requestOptions:operationContext:completionHandler:

Deletes the blob.

- (void)deleteWithSnapshotsOption:(AZSDeleteSnapshotsOption)snapshotsOption accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

snapshotsOption

If snapshots should be deleted. See AZSDeleteSnapshotsOption for more information.
accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the delete call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Deletes the blob.

This method deletes the blob on the service. It will fail if the blob does not exist.

Declared In

AZSCloudBlob.h

– uploadPropertiesWithCompletionHandler:

Updates the blob’s properties.

- (void)uploadPropertiesWithCompletionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

completionHandler

The block of code to execute when the Upload Properties call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Updates the blob’s properties.

Declared In

AZSCloudBlob.h

– uploadPropertiesWithAccessCondition:requestOptions:operationContext:completionHandler:

Updates the blob’s properties.

- (void)uploadPropertiesWithAccessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the Upload Properties call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Updates the blob’s properties.

Declared In

AZSCloudBlob.h

– uploadMetadataWithCompletionHandler:

Updates the blob’s user defined metadata.

- (void)uploadMetadataWithCompletionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

completionHandler

The block of code to execute when the Upload Metadata call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Updates the blob’s user defined metadata.

Declared In

AZSCloudBlob.h

– uploadMetadataWithAccessCondition:requestOptions:operationContext:completionHandler:

Updates the blob’s user defined metadata.

- (void)uploadMetadataWithAccessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the Upload Metadata call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Updates the blob’s user defined metadata.

Declared In

AZSCloudBlob.h

– downloadAttributesWithCompletionHandler:

Retrieves the blob’s attributes.

- (void)downloadAttributesWithCompletionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

completionHandler

The block of code to execute when the Fetch Attributes call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Retrieves the blob’s attributes.

Declared In

AZSCloudBlob.h

– downloadAttributesWithAccessCondition:requestOptions:operationContext:completionHandler:

Retrieves the blob’s attributes.

- (void)downloadAttributesWithAccessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the Fetch Attributes call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Retrieves the blob’s attributes.

Declared In

AZSCloudBlob.h

– snapshotBlobWithMetadata:completionHandler:

Snapshots the blob.

- (void)snapshotBlobWithMetadata:(AZSNullable NSDictionary *)metadata completionHandler:(void ( ^ ) ( NSError *__AZSNullable , AZSCloudBlob *__AZSNullable ))completionHandler

Parameters

metadata

The metadata to set on the blob snapshot. If nil, the snapshot will copy the metadata of the base blob.
completionHandler

The block of code to execute when the snapshot call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
AZSCloudBlob * The blob object that represents the snapshot. It will have the snapshotTime property set.

Discussion

Snapshots the blob.

This method creates a snapshot of the blob on the service.

Declared In

AZSCloudBlob.h

– snapshotBlobWithMetadata:accessCondition:requestOptions:operationContext:completionHandler:

Snapshots the blob.

- (void)snapshotBlobWithMetadata:(AZSNullable NSDictionary *)metadata accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable , AZSCloudBlob *__AZSNullable ))completionHandler

Parameters

metadata

The metadata to set on the blob snapshot. If nil, the snapshot will copy the metadata of the base blob.
accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the snapshot call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
AZSCloudBlob * The blob object that represents the snapshot. It will have the snapshotTime property set.

Discussion

Snapshots the blob.

This method creates a snapshot of the blob on the service.

Declared In

AZSCloudBlob.h

– existsWithCompletionHandler:

Checks to see if the blob exists.

- (void)existsWithCompletionHandler:(void ( ^ ) ( NSError *__AZSNullable , BOOL ))completionHandler

Parameters

completionHandler

The block of code to execute when the snapshot call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
BOOL YES if the blob object exists on the service, NO else.

Discussion

Checks to see if the blob exists.

This method queries the service to determine if the blob exists.

Declared In

AZSCloudBlob.h

– existsWithAccessCondition:requestOptions:operationContext:completionHandler:

Checks to see if the blob exists.

- (void)existsWithAccessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable , BOOL ))completionHandler

Parameters

accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the snapshot call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
BOOL YES if the blob object exists on the service, NO else.

Discussion

Checks to see if the blob exists.

This method queries the service to determine if the blob exists.

Declared In

AZSCloudBlob.h

– createSharedAccessSignatureWithParameters:error:

Creates a Shared Access Signature (SAS) token from the given policy for this Blob. Note that logging in this method uses the global logger configured statically on the AZSOperationContext as there is no operation being performed to provide a local operation context.

- (NSString *)createSharedAccessSignatureWithParameters:(AZSSharedAccessBlobParameters *)parameters error:(NSError **)error

Parameters

parameters

The shared access blob parameters from which to create the SAS token.
error

A pointer to a NSError*, to be set in the event of failure.

Return Value

The newly created SAS token.

Discussion

Creates a Shared Access Signature (SAS) token from the given policy for this Blob. Note that logging in this method uses the global logger configured statically on the AZSOperationContext as there is no operation being performed to provide a local operation context.

Declared In

AZSCloudBlob.h

– acquireLeaseWithLeaseTime:proposedLeaseId:completionHandler:

Acquires a lease on this blob.

- (void)acquireLeaseWithLeaseTime:(AZSNullable NSNumber *)leaseTime proposedLeaseId:(AZSNullable NSString *)proposedLeaseId completionHandler:(void ( ^ ) ( NSError *__AZSNullable , NSString *__AZSNullable ))completionHandler

Parameters

leaseTime

The span of time for which to acquire the lease, rounded down to seconds. If NIL, an infinite lease will be acquired. Must be greater than zero.
proposedLeaseId

The proposed lease ID for the new lease, or NIL if no lease ID is proposed.
completionHandler

The block of code to execute when the Acquire Lease call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
NSString * The ID of the acquired lease.

Discussion

Acquires a lease on this blob.

Declared In

AZSCloudBlob.h

– acquireLeaseWithLeaseTime:proposedLeaseId:accessCondition:requestOptions:operationContext:completionHandler:

Acquires a lease on this blob.

- (void)acquireLeaseWithLeaseTime:(AZSNullable NSNumber *)leaseTime proposedLeaseId:(AZSNullable NSString *)proposedLeaseId accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable , NSString *__AZSNullable ))completionHandler

Parameters

leaseTime

The span of time for which to acquire the lease, rounded down to seconds. If NIL, an infinite lease will be acquired. Must be greater than zero.
proposedLeaseId

The proposed lease ID for the new lease, or NIL if no lease ID is proposed.
accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the Acquire Lease call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
NSString * The ID of the acquired lease.

Discussion

Acquires a lease on this blob.

Declared In

AZSCloudBlob.h

– breakLeaseWithBreakPeriod:completionHandler:

Breaks the current lease on this blob.

- (void)breakLeaseWithBreakPeriod:(AZSNullable NSNumber *)breakPeriod completionHandler:(void ( ^ ) ( NSError *__AZSNullable , NSNumber *__AZSNullable ))completionHandler

Parameters

breakPeriod

The span of time for which to allow the lease to remain, rounded down to seconds. If NIL, the break period will be the remainder of the current lease or zero for an infinite lease.
completionHandler

The block of code to execute when the Break Lease call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
NSNumber * The amount of time before the lease ends, to the second.

Discussion

Breaks the current lease on this blob.

Declared In

AZSCloudBlob.h

– breakLeaseWithBreakPeriod:accessCondition:requestOptions:operationContext:completionHandler:

Breaks the current lease on this blob.

- (void)breakLeaseWithBreakPeriod:(AZSNullable NSNumber *)breakPeriod accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable , NSNumber *__AZSNullable ))completionHandler

Parameters

breakPeriod

The span of time for which to allow the lease to remain, rounded down to seconds. If NIL, the break period will be the remainder of the current lease or zero for an infinite lease.
accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the Break Lease call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
NSNumber * The amount of time before the lease ends, to the second.

Discussion

Breaks the current lease on this blob.

Declared In

AZSCloudBlob.h

– changeLeaseWithProposedLeaseId:accessCondition:completionHandler:

Changes the lease ID on this blob.

- (void)changeLeaseWithProposedLeaseId:(NSString *)proposedLeaseId accessCondition:(AZSNullable AZSAccessCondition *)accessCondition completionHandler:(void ( ^ ) ( NSError *__AZSNullable , NSString *__AZSNullable ))completionHandler

Parameters

proposedLeaseId

The proposed lease ID for the new lease, which cannot be null.
accessCondition

The access condition for the request.
completionHandler

The block of code to execute when the Change Lease call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
NSString * The new lease ID.

Discussion

Changes the lease ID on this blob.

Declared In

AZSCloudBlob.h

– changeLeaseWithProposedLeaseId:accessCondition:requestOptions:operationContext:completionHandler:

Changes the lease ID on this blob.

- (void)changeLeaseWithProposedLeaseId:(NSString *)proposedLeaseId accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable , NSString *__AZSNullable ))completionHandler

Parameters

proposedLeaseId

The proposed lease ID for the new lease, which cannot be null.
accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the Change Lease call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
NSString * The new lease ID.

Discussion

Changes the lease ID on this blob.

Declared In

AZSCloudBlob.h

– releaseLeaseWithAccessCondition:completionHandler:

Releases the lease on this blob.

- (void)releaseLeaseWithAccessCondition:(AZSNullable AZSAccessCondition *)accessCondition completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

accessCondition

The access condition for the request.
completionHandler

The block of code to execute when the Release Lease call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Releases the lease on this blob.

Declared In

AZSCloudBlob.h

– releaseLeaseWithAccessCondition:requestOptions:operationContext:completionHandler:

Releases the lease on this blob.

- (void)releaseLeaseWithAccessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the Release Lease call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Releases the lease on this blob.

Declared In

AZSCloudBlob.h

– renewLeaseWithAccessCondition:completionHandler:

Renews a lease on this blob.

- (void)renewLeaseWithAccessCondition:(AZSNullable AZSAccessCondition *)accessCondition completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

accessCondition

The access condition for the request.
completionHandler

The block of code to execute when the Renew Lease call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Renews a lease on this blob.

Declared In

AZSCloudBlob.h

– renewLeaseWithAccessCondition:requestOptions:operationContext:completionHandler:

Renews a lease on this blob.

- (void)renewLeaseWithAccessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the Renew Lease call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Renews a lease on this blob.

Declared In

AZSCloudBlob.h

– downloadToDataWithCompletionHandler:

Downloads contents of a blob to an NSData object.

- (void)downloadToDataWithCompletionHandler:(void ( ^ ) ( NSError *__AZSNullable , NSData *__AZSNullable ))completionHandler

Parameters

completionHandler

The block of code to execute when the call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
NSData * The NSData object containing the data from the blob.

Discussion

Downloads contents of a blob to an NSData object.

Declared In

AZSCloudBlob.h

– downloadToDataWithAccessCondition:requestOptions:operationContext:completionHandler:

Downloads contents of a blob to an NSData object.

- (void)downloadToDataWithAccessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable , NSData *__AZSNullable ))completionHandler

Parameters

accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
NSData * The NSData object containing the data from the blob.

Discussion

Downloads contents of a blob to an NSData object.

Declared In

AZSCloudBlob.h

– downloadToTextWithCompletionHandler:

Downloads contents of a blob to an NSString. Blob contents will be interpreted as UTF-8.

- (void)downloadToTextWithCompletionHandler:(void ( ^ ) ( NSError *__AZSNullable , NSString *__AZSNullable ))completionHandler

Parameters

completionHandler

The block of code to execute when the call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
NSString * The NSString object containing the text from the blob.

Discussion

Downloads contents of a blob to an NSString. Blob contents will be interpreted as UTF-8.

Declared In

AZSCloudBlob.h

– downloadToTextWithAccessCondition:requestOptions:operationContext:completionHandler:

Downloads contents of a blob to an NSString. Blob contents will be interpreted as UTF-8.

- (void)downloadToTextWithAccessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable , NSString *__AZSNullable ))completionHandler

Parameters

accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
NSString * The NSString object containing the text from the blob.

Discussion

Downloads contents of a blob to an NSString. Blob contents will be interpreted as UTF-8.

Declared In

AZSCloudBlob.h

– downloadToFileWithPath:append:completionHandler:

Downloads contents of a blob to a file.

- (void)downloadToFileWithPath:(NSString *)filePath append:(BOOL)shouldAppend completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

filePath

The path to the file to download the blob to.
shouldAppend

YES if newly written data should be appended to any existing file contents, NO otherwise.
completionHandler

The block of code to execute when the call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Downloads contents of a blob to a file.

Declared In

AZSCloudBlob.h

– downloadToFileWithPath:append:accessCondition:requestOptions:operationContext:completionHandler:

Downloads contents of a blob to a file.

- (void)downloadToFileWithPath:(NSString *)filePath append:(BOOL)shouldAppend accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

filePath

The path to the file to download the blob to.
shouldAppend

YES if newly written data should be appended to any existing file contents, NO otherwise.
accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Downloads contents of a blob to a file.

Declared In

AZSCloudBlob.h

– downloadToFileWithURL:append:completionHandler:

Downloads contents of a blob to a file.

- (void)downloadToFileWithURL:(NSURL *)fileURL append:(BOOL)shouldAppend completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

fileURL

The URL to the file to download the blob to.
shouldAppend

YES if newly written data should be appended to any existing file contents, NO otherwise.
completionHandler

The block of code to execute when the call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Downloads contents of a blob to a file.

Declared In

AZSCloudBlob.h

– downloadToFileWithURL:append:accessCondition:requestOptions:operationContext:completionHandler:

Downloads contents of a blob to a file.

- (void)downloadToFileWithURL:(NSURL *)fileURL append:(BOOL)shouldAppend accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

fileURL

The URL to the file to download the blob to.
shouldAppend

YES if newly written data should be appended to any existing file contents, NO otherwise.
accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Downloads contents of a blob to a file.

Declared In

AZSCloudBlob.h

– startAsyncCopyFromBlob:completionHandler:

Begins an async, server-side copy to this AZSCloubBlob object.

- (void)startAsyncCopyFromBlob:(AZSCloudBlob *)sourceBlob completionHandler:(void ( ^ ) ( NSError *__AZSNullable , NSString *__AZSNullable ))completionHandler

Parameters

sourceBlob

The blob to use as the source for the copy.
completionHandler

The block of code to execute when the call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
NSString * The copy ID for the copy operation.

Discussion

Begins an async, server-side copy to this AZSCloubBlob object.

This method kicks off an async copy on the service. The copy will complete in the background.

Declared In

AZSCloudBlob.h

– startAsyncCopyFromBlob:sourceAccessCondition:destinationAccessCondition:requestOptions:operationContext:completionHandler:

Begins an async, server-side copy to this AZSCloubBlob object.

- (void)startAsyncCopyFromBlob:(AZSCloudBlob *)sourceBlob sourceAccessCondition:(AZSNullable AZSAccessCondition *)sourceAccessCondition destinationAccessCondition:(AZSNullable AZSAccessCondition *)destinationAccessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable , NSString *__AZSNullable ))completionHandler

Parameters

sourceBlob

The blob to use as the source for the copy.
sourceAccessCondition

The access condition to use to access the source for the copy.
destinationAccessCondition

The access condition to use to access this blob (the destination)
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
NSString * The copy ID for the copy operation.

Discussion

Begins an async, server-side copy to this AZSCloubBlob object.

This method kicks off an async copy on the service. The copy will complete in the background.

Declared In

AZSCloudBlob.h

– startAsyncCopyFromURL:completionHandler:

Begins an async, server-side copy to this AZSCloubBlob object.

- (void)startAsyncCopyFromURL:(NSURL *)sourceURL completionHandler:(void ( ^ ) ( NSError *__AZSNullable , NSString *__AZSNullable ))completionHandler

Parameters

sourceURL

The URL to use as the source for the copy.
completionHandler

The block of code to execute when the call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
NSString * The copy ID for the copy operation.

Discussion

Begins an async, server-side copy to this AZSCloubBlob object.

This method kicks off an async copy on the service. The copy will complete in the background.

Declared In

AZSCloudBlob.h

– startAsyncCopyFromURL:sourceAccessCondition:destinationAccessCondition:requestOptions:operationContext:completionHandler:

Begins an async, server-side copy to this AZSCloubBlob object.

- (void)startAsyncCopyFromURL:(NSURL *)sourceURL sourceAccessCondition:(AZSNullable AZSAccessCondition *)sourceAccessCondition destinationAccessCondition:(AZSNullable AZSAccessCondition *)destinationAccessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable , NSString *__AZSNullable ))completionHandler

Parameters

sourceURL

The URL to use as the source for the copy.
sourceAccessCondition

The access condition to use to access the source for the copy.
destinationAccessCondition

The access condition to use to access this blob (the destination)
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
NSString * The copy ID for the copy operation.

Discussion

Begins an async, server-side copy to this AZSCloubBlob object.

This method kicks off an async copy on the service. The copy will complete in the background.

Declared In

AZSCloudBlob.h

– abortAsyncCopyWithCopyId:completionHandler:

Aborts an async copy operation on the service. The copy operation must be one with this blob (self) as the destination.

- (void)abortAsyncCopyWithCopyId:(NSString *)copyId completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

copyId

The ID of the copy operation to abort.
completionHandler

The block of code to execute when the call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Aborts an async copy operation on the service. The copy operation must be one with this blob (self) as the destination.

Declared In

AZSCloudBlob.h

– abortAsyncCopyWithCopyId:accessCondition:requestOptions:operationContext:completionHandler:

Aborts an async copy operation on the service. The copy operation must be one with this blob (self) as the destination.

- (void)abortAsyncCopyWithCopyId:(NSString *)copyId accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

copyId

The ID of the copy operation to abort.
accessCondition

The access condition for the request.
requestOptions

The options to use for the request.
operationContext

The operation context to use for the call.
completionHandler

The block of code to execute when the call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Aborts an async copy operation on the service. The copy operation must be one with this blob (self) as the destination.

Declared In

AZSCloudBlob.h