ALAssetController Class Reference

Inherits from NSObject
Declared in ALAssetController.h

Overview

Manages assets used by a scan plugin

  assetContext

The context used containing information about the asset

@property (nonatomic) ALAssetContext *assetContext

Declared In

ALAssetController.h

– initWithContext:delegate:

Initialize an asset controller

- (instancetype)initWithContext:(ALAssetContext *)context delegate:(NSObject<ALAssetDelegate> *)delegate

Parameters

context

the asset context used

delegate

the delegate

Declared In

ALAssetController.h

– initWithContext:

Initialize an asset controller

- (instancetype)initWithContext:(ALAssetContext *)context

Parameters

context

the asset context used

Declared In

ALAssetController.h

– checkForUpdates

Checks whether asset updates are available

- (void)checkForUpdates

Declared In

ALAssetController.h

– reportingValues

Values that can be reported

- (NSString *__nullable)reportingValues

Declared In

ALAssetController.h

– assetID

The asset ID

- (NSString *__nullable)assetID

Declared In

ALAssetController.h

– projectID

The project ID

- (NSString *__nullable)projectID

Declared In

ALAssetController.h

– path

The filesystem path of the assets

- (NSString *)path

Declared In

ALAssetController.h

– updateAssets

Updates the assets, only after {@link #checkForUpdates()} was successfully called

- (void)updateAssets

Declared In

ALAssetController.h

– setupAssetUpdateWithContext:delegate:

Sets up the update process for an asset

- (void)setupAssetUpdateWithContext:(nonnull ALAssetContext *)context delegate:(nullable NSObject<ALAssetDelegate> *)delegate

Parameters

context

the asset context

delegate

the delegate

Declared In

ALAssetController.h

– isActive

Returns true if ‘setupAssetUpdateWithContext:delegate:’ was called. Returns false if ‘resetAssetUpdate’ was called or setupAssetUpdateWithContext:delegate:‘ has not been called.

- (BOOL)isActive

Declared In

ALAssetController.h

– resetAssetUpdate

Resets the asset update functionality. After this is called, setupAssetUpdateWithContext:delegate: must be called again.

- (void)resetAssetUpdate

Declared In

ALAssetController.h

– cancel

Cancels the asset update process

- (void)cancel

Declared In

ALAssetController.h

– isAssetUpdateCanceled

Returns true if ‘cancelUpdate’ was called

- (BOOL)isAssetUpdateCanceled

Declared In

ALAssetController.h

– areLocalAssetsAvailable

Whether any assets have been downloaded. If this returns NO, you should either check for updates and download the updates, or not use an asset context.

- (BOOL)areLocalAssetsAvailable

Declared In

ALAssetController.h

– deleteLocalAssets

Deletes any assets that have been downloaded. After doing this, you should either check for updates and download the updates, or not use an asset context.

- (void)deleteLocalAssets

Declared In

ALAssetController.h

– createBackup

Creates a back up of the assets

- (void)createBackup

Declared In

ALAssetController.h

– restoreFromBackup

Restores the backup of the assets, if they exist

- (void)restoreFromBackup

Declared In

ALAssetController.h

– deleteBackup

Deletes the backup of the assets

- (void)deleteBackup

Declared In

ALAssetController.h