FileInfo

Extends

• Entity

Constructors

new FileInfo()

new FileInfo(dart): FileInfo

Parameters

Parameter	Type
dart	any

Returns

FileInfo

Overrides

Entity . constructor

Constructs

FileInfo

Source

src/entities.ts:888

Properties

Property	Modifier	Type	Inherited from
dart	public	any	Entity.dart

Accessors

author

get author(): User

Who created entity *

Returns

User

Source

src/entities.ts:124

---

connection

get connection(): DataConnection

Returns

DataConnection

Source

src/entities.ts:892

---

createdOn

get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Source

src/entities.ts:115

---

data

get data(): Uint8Array

Returns

Uint8Array

Source

src/entities.ts:928

---

extension

get extension(): string

Returns file extension, i.e. csv

Returns

string

Source

src/entities.ts:904

---

fileName

get fileName(): string

Returns file name, i.e. dmv_offices.csv

Returns

string

Source

src/entities.ts:907

---

friendlyName

get friendlyName(): string

Entity friendly name

set friendlyName(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:101

---

fullPath

get fullPath(): string

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

Returns

string

Source

src/entities.ts:898

---

id

get id(): string

Entity ID (GUID)

set id(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:93

---

isDirectory

get isDirectory(): boolean

Checks if directory

Returns

boolean

Source

src/entities.ts:916

---

isFile

get isFile(): boolean

Checks if file

Returns

boolean

Source

src/entities.ts:913

---

name

get name(): string

Entity short name

set name(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:105

---

nqName

get nqName(): string

Entity full-qualified name

Returns

string

Source

src/entities.ts:109

---

path

get path(): string

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

Returns

string

Source

src/entities.ts:895

---

updatedOn

get updatedOn(): null | Dayjs

Time when entity was updated *

Returns

null | Dayjs

Source

src/entities.ts:918

---

url

get url(): string

Returns file URL

Returns

string

Source

src/entities.ts:910

---

viewPath

get viewPath(): string

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

Returns

string

Source

src/entities.ts:901

Methods

getProperties()

getProperties(): Promise<object>

Gets entity properties

Returns

Promise<object>

Inherited from

Entity . getProperties

Source

src/entities.ts:127

---

hasTag()

hasTag(tag): boolean

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . hasTag

Source

src/entities.ts:139

---

newId()

newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity . newId

Source

src/entities.ts:97

---

readAsBytes()

readAsBytes(): Promise<Uint8Array>

Returns

Promise<Uint8Array>

Source

src/entities.ts:935

---

readAsString()

readAsString(): Promise<string>

Returns

Promise<string>

Source

src/entities.ts:930

---

setProperties()

setProperties(props): Promise<any>

Sets entity properties

Parameters

Parameter	Type
props	object

Returns

Promise<any>

Inherited from

Entity . setProperties

Source

src/entities.ts:132

---

tag()

tag(tag): boolean

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . tag

Source

src/entities.ts:142

---

toString()

toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity . toString

Source

src/entities.ts:137

---

unTag()

unTag(tag): boolean

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . unTag

Source

src/entities.ts:145

---

fromBytes()

static fromBytes(path, data): FileInfo

Parameters

Parameter	Type
path	string
data	Uint8Array

Returns

FileInfo

Source

src/entities.ts:939

---

fromString()

static fromString(path, data): FileInfo

Parameters

Parameter	Type
path	string
data	string

Returns

FileInfo

Source

src/entities.ts:945