ALScanViewPluginBase Protocol Reference

Conforms to NSObject
Declared in ALScanViewPluginBase.h

Overview

Base interface for scan view plugins

  pluginID required method

Unique plugin ID for the scan view plugin

@property (nonatomic, readonly) NSString *pluginID

Declared In

ALScanViewPluginBase.h

  children required method

List of children plugins, if composite. Otherwise, empty

@property (nonatomic, readonly) NSArray<NSObject<ALScanViewPluginBase> *> *children

Declared In

ALScanViewPluginBase.h

  isStarted required method

Indicates whether or not the plugin has been started

@property (nonatomic, readonly) BOOL isStarted

Declared In

ALScanViewPluginBase.h

– startWithError: required method

Starts the plugin

- (BOOL)startWithError:(NSError *_Nullable *_Nullable)error

Parameters

error

if an error is encountered, this will be filled with the necessary information

Return Value

a boolean indicating whether or not the plugin was started successfully

Declared In

ALScanViewPluginBase.h

– stop required method

Stops the plugin

- (void)stop

Declared In

ALScanViewPluginBase.h