rmapi-js
    Preparing search index...

    Interface PutOptions

    options for putting a file onto reMarkable

    This is a more customizable version of the options available when using the simpler upload api. This comes with the risk that is uses lower level apis, and therefore has more failure points.

    Content and Metadata for more information on what these fields correspond to

    interface PutOptions {
        authors?: string[];
        coverPageNumber?: number;
        extraMetadata?: Record<string, string>;
        fontName?: string;
        lineHeight?: number;
        margins?: number;
        orientation?: Orientation;
        parent?: string;
        pinned?: boolean;
        publicationDate?: string;
        publisher?: string;
        refresh?: boolean;
        tags?: string[];
        textAlignment?: TextAlignment;
        textScale?: number;
        title?: string;
        viewBackgroundFilter?: BackgroundFilter;
        zoomMode?: ZoomMode;
    }
    Index

    Properties

    authors? coverPageNumber? extraMetadata? fontName? lineHeight? margins? orientation? parent? pinned? publicationDate? publisher? refresh? tags? textAlignment? textScale? title? viewBackgroundFilter? zoomMode?

    Properties

    authors?: string[]

    document metadata authors

    coverPageNumber?: number

    0 for first page, -1 for last visited

    extraMetadata?: Record<string, string>

    extra metadata often in the form of pen choices

    fontName?: string

    the font to use for rendering

    lineHeight?: number

    the line height to render

    margins?: number

    the margins to render

    orientation?: Orientation

    the document orientation

    parent?: string

    the collection to put this in

    The empty string ("") (default) is the root, "trash" is in the trash, otherwise this should be the uuid of a collection item to place this in.

    pinned?: boolean

    true to star the item

    publicationDate?: string

    the publication date, as an ISO date or timestamp

    publisher?: string

    the publisher

    refresh?: boolean

    whether to refresh current file structure before putting

    If you suspect that other changes have been made to the remarkable backend between the last put and now, setting this to true will avoid a GenerationError, but will cause an unnecessary GET request otherwise.

    tags?: string[]

    the names of the tags to add

    textAlignment?: TextAlignment

    the document text alignment

    textScale?: number

    the text scale of the document

    title?: string

    document metadata tile, NOTE this is not visibleName

    viewBackgroundFilter?: BackgroundFilter

    the contrast filter setting

    zoomMode?: ZoomMode

    the document zoom mode

    Settings

    Member Visibility

    On This Page

    Properties