"[iterator]"(): IterableIterator<[keyof { … }, string | number | Date | null]>"[iterator]"(): IterableIterator<
    [
        keyof {
            attachmentId: string;
            description: string
            | null;
            fileName: string | null;
            fileSize: number | null;
            id: string;
            updatedAt: Date | null;
        },
        string
        | number
        | Date
        | null,
    ],
>
Returns
IterableIterator<[keyof { … }, string | number | Date | null]>IterableIterator<
    [
        keyof {
            attachmentId: string;
            description: string
            | null;
            fileName: string | null;
            fileSize: number | null;
            id: string;
            updatedAt: Date | null;
        },
        string
        | number
        | Date
        | null,
    ],
>
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).[iterator]

asImmutable

Deprecated

asImmutable(): this
Returns
this
Deprecated
Use withMutations() in place of asMutable() and asImmutable().
See Also
Map#asImmutable
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).asImmutable

asMutable

Deprecated

asMutable(): this
Returns
this
Deprecated
Use withMutations(), making the changes inside its callback.
See Also
Map#asMutable
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).asMutable

clear

clear(): this
Returns a new instance of this Record type with all values set to their default values.

Returns
this
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).clear

delete

delete<K extends keyof { … }>(key: K): thisdelete<
    K extends
        keyof {
            attachmentId: string;
            description: string
            | null;
            fileName: string | null;
            fileSize: number | null;
            id: string;
            updatedAt: Date | null;
        },
>(
    key: K,
): this
Returns a new instance of this Record type with the value for the specific key set to its default value.

Type Parameters
K
extends keyof { … }extends keyof {
    attachmentId: string;
    description: string | null;
    fileName: string | null;
    fileSize: number | null;
    id: string;
    updatedAt: Date | null;
}
Parameters
keyK
Returns
this
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).delete

deleteIn

deleteIn(keyPath: Iterable<unknown>): this
Parameters
keyPathIterable<unknown>
Returns
this
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).deleteIn

equals

equals(other: unknown): boolean
Parameters
otherunknown
Returns
boolean
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).equals

get

get<K extends keyof { … }>(key: K, notSetValue?: unknown): { … }[K]get<
    K extends
        keyof {
            attachmentId: string;
            description: string
            | null;
            fileName: string | null;
            fileSize: number | null;
            id: string;
            updatedAt: Date | null;
        },
>(
    key: K,
    notSetValue?: unknown,
): {
    attachmentId: string;
    description: string | null;
    fileName: string | null;
    fileSize: number | null;
    id: string;
    updatedAt: Date | null;
}[K]
Returns the value associated with the provided key, which may be the default value defined when creating the Record factory function.

If the requested key is not defined by this Record type, then notSetValue will be returned if provided. Note that this scenario would produce an error when using Flow or TypeScript.

Type Parameters
K
extends keyof { … }extends keyof {
    attachmentId: string;
    description: string | null;
    fileName: string | null;
    fileSize: number | null;
    id: string;
    updatedAt: Date | null;
}
Parameters
keyK
notSetValueunknown
Optional
Returns
{ … }[K]{
    attachmentId: string;
    description: string | null;
    fileName: string | null;
    fileSize: number | null;
    id: string;
    updatedAt: Date | null;
}[K]
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).get
get<T>(key: string, notSetValue: T): T
Type Parameters
T
Parameters
keystring
notSetValueT
Returns
T
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).get

getIn

getIn(keyPath: Iterable<unknown>): unknown
Parameters
keyPathIterable<unknown>
Returns
unknown
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).getIn

has

has(
    key: string,
): key is
    | "id"
    | "updatedAt"
    | "description"
    | "fileName"
    | "attachmentId"
    | "fileSize"
Parameters
keystring
Returns
key is
| "id"
| "updatedAt"
| "description"
| "fileName"
| "attachmentId"
| "fileSize"
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).has

hashCode

Deprecated

hashCode(): number
Returns
number
Deprecated
Use equals() to compare values.

Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).hashCode

hasIn

hasIn(keyPath: Iterable<unknown>): boolean
Parameters
keyPathIterable<unknown>
Returns
boolean
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).hasIn

merge

merge(
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismerge(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                attachmentId: string;
                description: string
                | null;
                fileName: string | null;
                fileSize: number | null;
                id: string;
                updatedAt: Date | null;
            },
        >
    )[],
): this
Parameters
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            attachmentId: string;
            description: string
            | null;
            fileName: string | null;
            fileSize: number | null;
            id: string;
            updatedAt: Date | null;
        },
    >
)[]
Returns
this
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).merge

mergeDeep

mergeDeep(
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeep(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                attachmentId: string;
                description: string
                | null;
                fileName: string | null;
                fileSize: number | null;
                id: string;
                updatedAt: Date | null;
            },
        >
    )[],
): this
Parameters
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            attachmentId: string;
            description: string
            | null;
            fileName: string | null;
            fileSize: number | null;
            id: string;
            updatedAt: Date | null;
        },
    >
)[]
Returns
this
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).mergeDeep

mergeDeepIn

mergeDeepIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Parameters
keyPathIterable<unknown>
...collectionsunknown[]
Returns
this
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).mergeDeepIn

mergeDeepWith

mergeDeepWith(
    merger: (oldVal: unknown, newVal: unknown, key: unknown) => unknown,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeepWith(
    merger: (oldVal: unknown, newVal: unknown, key: unknown) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                attachmentId: string;
                description: string
                | null;
                fileName: string | null;
                fileSize: number | null;
                id: string;
                updatedAt: Date | null;
            },
        >
    )[],
): this
Parameters
merger(oldVal: unknown, newVal: unknown, key: unknown) => unknown
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            attachmentId: string;
            description: string
            | null;
            fileName: string | null;
            fileSize: number | null;
            id: string;
            updatedAt: Date | null;
        },
    >
)[]
Returns
this
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).mergeDeepWith

mergeIn

mergeIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Parameters
keyPathIterable<unknown>
...collectionsunknown[]
Returns
this
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).mergeIn

mergeWith

mergeWith(
    merger: (oldVal: unknown, newVal: unknown, key: keyof { … }) => unknown,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeWith(
    merger: (
        oldVal: unknown,
        newVal: unknown,
        key: keyof {
            attachmentId: string;
            description: string | null;
            fileName: string | null;
            fileSize: number | null;
            id: string;
            updatedAt: Date | null;
        },
    ) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                attachmentId: string;
                description: string
                | null;
                fileName: string | null;
                fileSize: number | null;
                id: string;
                updatedAt: Date | null;
            },
        >
    )[],
): this
Parameters
merger
(oldVal: unknown, newVal: unknown, key: keyof { … }) => unknown(
    oldVal: unknown,
    newVal: unknown,
    key: keyof {
        attachmentId: string;
        description: string | null;
        fileName: string | null;
        fileSize: number | null;
        id: string;
        updatedAt: Date | null;
    },
) => unknown
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            attachmentId: string;
            description: string
            | null;
            fileName: string | null;
            fileSize: number | null;
            id: string;
            updatedAt: Date | null;
        },
    >
)[]
Returns
this
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).mergeWith

remove

remove<K extends keyof { … }>(key: K): thisremove<
    K extends
        keyof {
            attachmentId: string;
            description: string
            | null;
            fileName: string | null;
            fileSize: number | null;
            id: string;
            updatedAt: Date | null;
        },
>(
    key: K,
): this
Type Parameters
K
extends keyof { … }extends keyof {
    attachmentId: string;
    description: string | null;
    fileName: string | null;
    fileSize: number | null;
    id: string;
    updatedAt: Date | null;
}
Parameters
keyK
Returns
this
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).remove

removeIn

removeIn(keyPath: Iterable<unknown>): this
Parameters
keyPathIterable<unknown>
Returns
this
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).removeIn

set

set<K extends keyof { … }>(key: K, value: { … }[K]): thisset<
    K extends
        keyof {
            attachmentId: string;
            description: string
            | null;
            fileName: string | null;
            fileSize: number | null;
            id: string;
            updatedAt: Date | null;
        },
>(
    key: K,
    value: {
        attachmentId: string;
        description: string | null;
        fileName: string | null;
        fileSize: number | null;
        id: string;
        updatedAt: Date | null;
    }[K],
): this
Type Parameters
K
extends keyof { … }extends keyof {
    attachmentId: string;
    description: string | null;
    fileName: string | null;
    fileSize: number | null;
    id: string;
    updatedAt: Date | null;
}
Parameters
keyK
value
{ … }[K]{
    attachmentId: string;
    description: string | null;
    fileName: string | null;
    fileSize: number | null;
    id: string;
    updatedAt: Date | null;
}[K]
Returns
this
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).set

setIn

setIn(keyPath: Iterable<unknown>, value: unknown): this
Parameters
keyPathIterable<unknown>
valueunknown
Returns
this
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).setIn

toJS

toJS(): { … }toJS(): {
    attachmentId: string;
    description: string
    | null;
    fileName: string | null;
    fileSize: number | null;
    id: string;
    updatedAt: unknown;
}
Deeply converts this Record to equivalent native JavaScript Object.

Note: This method may not be overridden. Objects with custom serialization to plain JS may override toJSON() instead.

Returns
{ … }{
    attachmentId: string;
    description: string | null;
    fileName: string | null;
    fileSize: number | null;
    id: string;
    updatedAt: unknown;
}
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).toJS

toJSON

toJSON(): { … }toJSON(): {
    attachmentId: string;
    description: string
    | null;
    fileName: string | null;
    fileSize: number | null;
    id: string;
    updatedAt: Date | null;
}
Shallowly converts this Record to equivalent native JavaScript Object.

Returns
{ … }{
    attachmentId: string;
    description: string | null;
    fileName: string | null;
    fileSize: number | null;
    id: string;
    updatedAt: Date | null;
}
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).toJSON

toObject

toObject(): { … }toObject(): {
    attachmentId: string;
    description: string
    | null;
    fileName: string | null;
    fileSize: number | null;
    id: string;
    updatedAt: Date | null;
}
Shallowly converts this Record to equivalent JavaScript Object.

Returns
{ … }{
    attachmentId: string;
    description: string | null;
    fileName: string | null;
    fileSize: number | null;
    id: string;
    updatedAt: Date | null;
}
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).toObject

toSeq

Deprecated

toSeq(): Keyed<keyof { … }, string | number | Date | null>toSeq(): Keyed<
    keyof {
        attachmentId: string;
        description: string
        | null;
        fileName: string | null;
        fileSize: number | null;
        id: string;
        updatedAt: Date | null;
    },
    string
    | number
    | Date
    | null,
>
Returns
Keyed<keyof { … }, string | number | Date | null>Keyed<
    keyof {
        attachmentId: string;
        description: string
        | null;
        fileName: string | null;
        fileSize: number | null;
        id: string;
        updatedAt: Date | null;
    },
    string
    | number
    | Date
    | null,
>
Deprecated
Use toJSON(), which returns a plain object of its fields.

Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).toSeq

update

update<K extends keyof { … }>(
    key: K,
    updater: (value: { … }[K]) => { … }[K],
): thisupdate<
    K extends
        keyof {
            attachmentId: string;
            description: string
            | null;
            fileName: string | null;
            fileSize: number | null;
            id: string;
            updatedAt: Date | null;
        },
>(
    key: K,
    updater: (
        value: {
            attachmentId: string;
            description: string | null;
            fileName: string | null;
            fileSize: number | null;
            id: string;
            updatedAt: Date | null;
        }[K],
    ) => {
        attachmentId: string;
        description: string
        | null;
        fileName: string | null;
        fileSize: number | null;
        id: string;
        updatedAt: Date | null;
    }[K],
): this
Type Parameters
K
extends keyof { … }extends keyof {
    attachmentId: string;
    description: string | null;
    fileName: string | null;
    fileSize: number | null;
    id: string;
    updatedAt: Date | null;
}
Parameters
keyK
updater
(value: { … }[K]) => { … }[K](
    value: {
        attachmentId: string;
        description: string | null;
        fileName: string | null;
        fileSize: number | null;
        id: string;
        updatedAt: Date | null;
    }[K],
) => {
    attachmentId: string;
    description: string
    | null;
    fileName: string | null;
    fileSize: number | null;
    id: string;
    updatedAt: Date | null;
}[K]
Returns
this
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).update

updateIn

updateIn(keyPath: Iterable<unknown>, updater: (value: unknown) => unknown): this
Parameters
keyPathIterable<unknown>
updater(value: unknown) => unknown
Returns
this
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).updateIn

wasAltered

Deprecated

wasAltered(): boolean
Returns
boolean
Deprecated
Compare the result of withMutations() with the original using !==; it returns the original when nothing changed.
See Also
Map#wasAltered
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).wasAltered

withMutations

withMutations(mutator: (mutable: this) => unknown): this
Note: Not all methods can be used on a mutable collection or within withMutations! Only set may be used mutatively.
Parameters
mutator(mutable: this) => unknown
Returns
this
See Also
Map#withMutations
Inherited from ImmutableRecord<IEmbeddedFile>({ id: '', /** * A unique identifier that can be used to fetch the contents of the file. * * ```js * const embeddedFiles = await instance.getEmbeddedFiles() * * const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId) * ``` */ attachmentId: '', /** * The description of the file if present. * * @default null */ description: null, /** * The name of the file with extension. * * @default null */ fileName: null, /** * Size of the file in bytes. * * @default null */ fileSize: null, /** * The date on which the embedded file was updated. * * @default null */ updatedAt: null, }).withMutations

Interface EmbeddedFile

See Also

Hierarchy

Properties

Immutable Record API

Returns

Returns

Deprecated

See Also

Returns

Deprecated

See Also

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Deprecated

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Deprecated

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

Deprecated

See Also

Parameters

Returns

See Also