Class ModelFile

File

Constructors

constructor

Properties

access archived archivedAt? createdAt defaultHostingUrl? encoding? expiresAt? extension? height? id isUsableInContent? name? parentFolderId? path? size? type? updatedAt url? width? attributeTypeMap discriminator

Methods

getAttributeTypeMap

Constructors

constructor

Properties

access

access: ModelFileAccessEnum

File access. Can be PUBLIC_INDEXABLE, PUBLIC_NOT_INDEXABLE, PRIVATE.

archived

archived: boolean

If the file is deleted.

OptionalarchivedAt

archivedAt?: Date

Deletion time of the file object.

createdAt

createdAt: Date

Creation time of the file object.

OptionaldefaultHostingUrl

defaultHostingUrl?: string

Default hosting URL of the file. This will use one of HubSpot's provided URLs to serve the file.

Optionalencoding

encoding?: string

Encoding of the file.

OptionalexpiresAt

expiresAt?: number

Optionalextension

extension?: string

Extension of the file. ex: .jpg, .png, .gif, .pdf, etc.

Optionalheight

height?: number

For image and video files, the height of the content.

id

id: string

File ID.

OptionalisUsableInContent

isUsableInContent?: boolean

Previously "archied". Indicates if the file should be used when creating new content like web pages.

Optionalname

name?: string

Name of the file.

OptionalparentFolderId

parentFolderId?: string

ID of the folder the file is in.

Optionalpath

path?: string

Path of the file in the file manager.

Optionalsize

size?: number

Size of the file in bytes.

Optionaltype

type?: string

Type of the file. Can be IMG, DOCUMENT, AUDIO, MOVIE, or OTHER.

updatedAt

updatedAt: Date

Timestamp of the latest update to the file.

Optionalurl

url?: string

URL of the given file. This URL can change depending on the domain settings of the account. Will use the select file hosting domain.

Optionalwidth

width?: number

For image and video files, the width of the content.

Static ReadonlyattributeTypeMap

attributeTypeMap: {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[] = ...

Static Readonlydiscriminator

discriminator: undefined | string = undefined

Methods

StaticgetAttributeTypeMap

  • getAttributeTypeMap(): {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

  • Returns {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

Settings

Member Visibility

On This Page

Constructors
Properties
Methods