Skip to main content

Class: FileInfo

dg.FileInfo

Hierarchy

Constructors

constructor

new FileInfo(dart)

Constructs

FileInfo

Parameters

NameType
dartany

Overrides

Entity.constructor

Defined in

src/entities.ts:664

Properties

dart

dart: any

Inherited from

Entity.dart

Defined in

src/entities.ts:67

Accessors

author

get author(): User

Who created entity *

Returns

User

Inherited from

Entity.author

Defined in

src/entities.ts:104


createdOn

get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Inherited from

Entity.createdOn

Defined in

src/entities.ts:98


data

get data(): Uint8Array

Returns

Uint8Array

Defined in

src/entities.ts:694


extension

get extension(): string

Returns file extension, i.e. csv

Returns

string

Defined in

src/entities.ts:675


fileName

get fileName(): string

Returns file name, i.e. dmv_offices.csv

Returns

string

Defined in

src/entities.ts:678


friendlyName

get friendlyName(): string

Entity friendly name

Returns

string

Inherited from

Entity.friendlyName

Defined in

src/entities.ts:84

set friendlyName(x): void

Parameters

NameType
xstring

Returns

void

Inherited from

Entity.friendlyName

Defined in

src/entities.ts:85


fullPath

get fullPath(): string

Returns full path, i.e. Demo:TestJobs:Files:DemoFiles/geo/dmv_offices.csv

Returns

string

Defined in

src/entities.ts:672


id

get id(): string

Entity ID (GUID)

Returns

string

Inherited from

Entity.id

Defined in

src/entities.ts:76

set id(x): void

Parameters

NameType
xstring

Returns

void

Inherited from

Entity.id

Defined in

src/entities.ts:77


isDirectory

get isDirectory(): boolean

Checks if directory

Returns

boolean

Defined in

src/entities.ts:687


isFile

get isFile(): boolean

Checks if file

Returns

boolean

Defined in

src/entities.ts:684


name

get name(): string

Entity short name

Returns

string

Inherited from

Entity.name

Defined in

src/entities.ts:88

set name(x): void

Parameters

NameType
xstring

Returns

void

Inherited from

Entity.name

Defined in

src/entities.ts:89


nqName

get nqName(): string

Entity full-qualified name

Returns

string

Inherited from

Entity.nqName

Defined in

src/entities.ts:92


path

get path(): string

Returns path, i.e. geo/dmv_offices.csv

Returns

string

Overrides

Entity.path

Defined in

src/entities.ts:669


updatedOn

get updatedOn(): Dayjs

Time when entity was updated *

Returns

Dayjs

Inherited from

Entity.updatedOn

Defined in

src/entities.ts:101


url

get url(): string

Returns file URL

Returns

string

Defined in

src/entities.ts:681

Methods

getProperties

getProperties(): Promise<{ [index: string]: any; }>

Gets entity properties

Returns

Promise<{ [index: string]: any; }>

Inherited from

Entity.getProperties

Defined in

src/entities.ts:107


hasTag

hasTag(tag): boolean

Parameters

NameType
tagstring

Returns

boolean

Inherited from

Entity.hasTag

Defined in

src/entities.ts:119


newId

newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity.newId

Defined in

src/entities.ts:80


readAsBytes

readAsBytes(): Promise<Uint8Array>

Returns

Promise<Uint8Array>

Defined in

src/entities.ts:701


readAsString

readAsString(): Promise<string>

Returns

Promise<string>

Defined in

src/entities.ts:696


setProperties

setProperties(props): Promise<any>

Sets entity properties

Parameters

NameType
propsObject

Returns

Promise<any>

Inherited from

Entity.setProperties

Defined in

src/entities.ts:112


tag

tag(tag): boolean

Adds a specified tag

Parameters

NameType
tagstring

Returns

boolean

Inherited from

Entity.tag

Defined in

src/entities.ts:122


toString

toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity.toString

Defined in

src/entities.ts:117


unTag

unTag(tag): boolean

Removes a specified tag

Parameters

NameType
tagstring

Returns

boolean

Inherited from

Entity.unTag

Defined in

src/entities.ts:125


fromBytes

Static fromBytes(data): FileInfo

Parameters

NameType
dataUint8Array

Returns

FileInfo

Defined in

src/entities.ts:705


fromString

Static fromString(data): FileInfo

Parameters

NameType
datastring

Returns

FileInfo

Defined in

src/entities.ts:709