Class ConnectorInternal

Contains the result data.

Hierarchy

Properties

boardId captions? createdAt? createdBy? endItem? id isSupported? links? modifiedAt? modifiedBy? shape? startItem? style? type?

Methods

delete update

Properties

boardId

boardId: string

Optional captions

captions?: Caption[]

Blocks of text you want to display on the connector.

Optional createdAt

createdAt?: Date

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

Optional createdBy

createdBy?: CreatedBy

Optional endItem

endItem?: ItemConnectionWithLinks

id

id: string

Unique identifier (ID) of a connector.

Optional isSupported

isSupported?: boolean

Indicates whether the connector is supported at the moment. If this parameter returns false, we do not support the connector at the moment. We do not allow updates for unsupported connectors and we might not return all data about the connector, such as intermediate points and connection points to the canvas.

Optional links

links?: SelfLink

Optional modifiedAt

modifiedAt?: Date

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

Optional modifiedBy

modifiedBy?: ModifiedBy

Optional shape

shape?: string = ConnectorWithLinks.ShapeEnum.Curved

The path type of the connector line, defines curvature. Default: curved.

Optional startItem

startItem?: ItemConnectionWithLinks

Optional style

style?: ConnectorStyle

Optional type

type?: string

Type of board object that is returned.

Methods

delete

  • Deletes the specified connector from the board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Summary

    Delete connector

    Returns Promise<void>

update

  • Updates a connector on a board based on the data and style properties provided in the request body.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Update connector

    Parameters

    Returns Promise<void>

@mirohq/miro-api