Class DocumentItem

Hierarchy

BaseDocumentItem
- DocumentItem

Index

Properties

boardId createdAt? createdBy? data? geometry? id links? modifiedAt? modifiedBy? parent? position? type

Methods

connectTo delete update updateUsingFile updateUsingUrl

Properties

boardId

boardId: string

`Optional` createdAt

createdAt?: Date

Date and time when the item was created.
Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

`Optional` createdBy

createdBy?: CreatedBy

`Optional` data

data?: DocumentData

`Optional` geometry

geometry?: Geometry

id

id: string

Unique identifier (ID) of an item.

`Optional` links

links?: WidgetLinks

`Optional` modifiedAt

modifiedAt?: Date

Date and time when the item was last modified.
Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

`Optional` modifiedBy

modifiedBy?: ModifiedBy

`Optional` parent

parent?: ParentLinksEnvelope

`Optional` position

position?: Position

type

type: "document" = 'document'

Type of item that is returned.

Methods

connectTo

connectTo: ((endItem: string | number | ItemConnectionCreationData, connectorCreationData?: ConnectorCreationData) => Promise<Connector>) = ConnectableItem.prototype.connectTo

Type declaration

- (endItem: string | number | ItemConnectionCreationData, connectorCreationData?: ConnectorCreationData): Promise<Connector>
- Parameters
  - endItem: string | number | ItemConnectionCreationData
  - Optional connectorCreationData: ConnectorCreationData
  Returns Promise<Connector>

delete

delete(): Promise<void>
Deletes a document item from the board.
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

Summary
Delete document item

Returns Promise<void>
- Defined in highlevel/index.ts:990

update

update(request: DocumentUpdateRequest | Partial<WidgetCreateWithBufferRequest>): Promise<void>
Updates a document item on a board
Required scope
boards:write
Rate limiting
Level 2

This method can be used to update the document item with a new URL or from a document file.

Summary
Update document item
Parameters
- request: DocumentUpdateRequest | Partial<WidgetCreateWithBufferRequest>
  
  If request.data.url is set then the URL will be used to create a document otherwise contents of a request.data.data will be uploaded and used to create a document
Returns Promise<void>
Inherited from BaseDocumentItem.update
- Defined in highlevel/DocumentItem.ts:25

updateUsingFile

updateUsingFile(resource: RequestFile, data: undefined | UploadFileFromDeviceData): Promise<void>
Updates a document item on a board by using file from a device.
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

Summary
Update document item using file from device
Parameters
- resource: RequestFile
  
  Select a file to upload. Maximum file size is 6 MB.
- data: undefined | UploadFileFromDeviceData
Returns Promise<void>
- Defined in highlevel/index.ts:970

updateUsingUrl

updateUsingUrl(documentUpdateRequest: DocumentUpdateRequest): Promise<void>
Updates a document item on a board
Required scope
boards:write
Rate limiting
<a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

Summary
Update document item using URL
Parameters
- documentUpdateRequest: DocumentUpdateRequest
Returns Promise<void>
- Defined in highlevel/index.ts:982