Table of Contents

Class SBSDKScannedDocument

Namespace
ScanbotSDK.iOS
Assembly
DocumentSDK.NET.iOS.dll
public class SBSDKScannedDocument : NSObject
Inheritance
SBSDKScannedDocument

Constructors

SBSDKScannedDocument() 

public SBSDKScannedDocument()

SBSDKScannedDocument(NSObjectFlag) 

protected SBSDKScannedDocument(NSObjectFlag t)

Parameters

t NSObjectFlag

SBSDKScannedDocument(NativeHandle) 

protected SBSDKScannedDocument(NativeHandle handle)

Parameters

handle NativeHandle

SBSDKScannedDocument(SBSDKDocument, nint) 

public SBSDKScannedDocument(SBSDKDocument document, nint documentImageSizeLimit)

Parameters

document SBSDKDocument
documentImageSizeLimit nint

SBSDKScannedDocument(SBSDKScannedDocument) 

public SBSDKScannedDocument(SBSDKScannedDocument document)

Parameters

document SBSDKScannedDocument

SBSDKScannedDocument(nint) 

public SBSDKScannedDocument(nint documentImageSizeLimit)

Parameters

documentImageSizeLimit nint

SBSDKScannedDocument(string) 

public SBSDKScannedDocument(string documentUuid)

Parameters

documentUuid string

Properties

ClassHandle 

public override NativeHandle ClassHandle { get; }

Property Value

NativeHandle

CreationDate 

public virtual NSDate CreationDate { get; }

Property Value

NSDate

CreationTimeStamp 

public virtual long CreationTimeStamp { get; }

Property Value

long

DocumentImageSizeLimit 

public virtual nint DocumentImageSizeLimit { get; }

Property Value

nint

DocumentImageURLs 

public virtual NSUrl[] DocumentImageURLs { get; }

Property Value

NSUrl[]

FileStorageBaseDirectory 

public static NSUrl FileStorageBaseDirectory { get; set; }

Property Value

NSUrl

FileStorageImageFormat 

public static SBSDKImageFileFormat FileStorageImageFormat { get; set; }

Property Value

SBSDKImageFileFormat

FileStorageImageQuality 

public static byte FileStorageImageQuality { get; set; }

Property Value

byte

Hash 

public virtual nuint Hash { get; }

Property Value

nuint

PageCount 

public virtual nint PageCount { get; }

Property Value

nint

PageUuids 

public virtual string[] PageUuids { get; }

Property Value

string[]

Pages 

public virtual SBSDKScannedPage[] Pages { get; }

Property Value

SBSDKScannedPage[]

PdfURI 

public virtual NSUrl PdfURI { get; }

Property Value

NSUrl

StoredDocumentUuids 

public static string[] StoredDocumentUuids { get; }

Property Value

string[]

TiffURI 

public virtual NSUrl TiffURI { get; }

Property Value

NSUrl

Uuid 

public virtual string Uuid { get; }

Property Value

string

Methods

AddObserver(SBSDKScannedDocumentObserver) 

public virtual void AddObserver(SBSDKScannedDocumentObserver observer)

Parameters

observer SBSDKScannedDocumentObserver

AddPageWith(UIImage, SBSDKPolygon, SBSDKParametricFilter[]) 

public virtual SBSDKScannedPage? AddPageWith(UIImage image, SBSDKPolygon polygon, SBSDKParametricFilter[] filters)

Parameters

image UIImage
polygon SBSDKPolygon
filters SBSDKParametricFilter[]

Returns

SBSDKScannedPage

Clone() 

public virtual SBSDKScannedDocument? Clone()

Returns

SBSDKScannedDocument

CreateDocumentWithDocumentImageSizeLimit(nint) 

public static SBSDKScannedDocument CreateDocumentWithDocumentImageSizeLimit(nint documentImageSizeLimit)

Parameters

documentImageSizeLimit nint

Returns

SBSDKScannedDocument

DeleteAndReturnError(out NSError?) 

public virtual bool DeleteAndReturnError(out NSError? error)

Parameters

error NSError

Returns

bool

DeleteDocumentWithDocumentUuid(string) 

public static bool DeleteDocumentWithDocumentUuid(string documentUuid)

Parameters

documentUuid string

Returns

bool

DocumentExistsWithDocumentUuid(string) 

public static bool DocumentExistsWithDocumentUuid(string documentUuid)

Parameters

documentUuid string

Returns

bool

InsertPageWithAt(UIImage, nint, SBSDKPolygon, SBSDKParametricFilter[]) 

public virtual SBSDKScannedPage? InsertPageWithAt(UIImage image, nint index, SBSDKPolygon polygon, SBSDKParametricFilter[] filters)

Parameters

image UIImage
index nint
polygon SBSDKPolygon
filters SBSDKParametricFilter[]

Returns

SBSDKScannedPage

LoadDocumentWithDocumentUuid(string) 

public static SBSDKScannedDocument? LoadDocumentWithDocumentUuid(string documentUuid)

Parameters

documentUuid string

Returns

SBSDKScannedDocument

MovePageAtTo(nint, nint) 

public virtual bool MovePageAtTo(nint sourceIndex, nint destIndex)

Parameters

sourceIndex nint
destIndex nint

Returns

bool

PageAt(nint) 

public virtual SBSDKScannedPage? PageAt(nint index)

Parameters

index nint

Returns

SBSDKScannedPage

PageExistsWithDocumentUuid(string, string) 

public static bool PageExistsWithDocumentUuid(string documentUuid, string pageUuid)

Parameters

documentUuid string
pageUuid string

Returns

bool

PageWith(string) 

public virtual SBSDKScannedPage? PageWith(string pageUuid)

Parameters

pageUuid string

Returns

SBSDKScannedPage

RebuildPages() 

public virtual void RebuildPages()

RemoveAllPagesOnError(Action<SBSDKScannedPage, NSError>?) 

public virtual void RemoveAllPagesOnError(Action<SBSDKScannedPage, NSError>? onError)

Parameters

onError Action<SBSDKScannedPage, NSError>

RemoveObserver(SBSDKScannedDocumentObserver) 

public virtual void RemoveObserver(SBSDKScannedDocumentObserver observer)

Parameters

observer SBSDKScannedDocumentObserver

RemovePage(SBSDKScannedPage, Action<SBSDKScannedPage, NSError>?) 

public virtual void RemovePage(SBSDKScannedPage page, Action<SBSDKScannedPage, NSError>? onError)

Parameters

page SBSDKScannedPage
onError Action<SBSDKScannedPage, NSError>

ToJson() 

public virtual string ToJson()

Returns

string