Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProtonLinkOptions

Options for configuring link attributes.

Hierarchy

  • ProtonLinkOptions

Index

Constructors

Methods

Constructors

constructor

Methods

getLinkName

  • getLinkName(): string

  • Returns string

isDynamic

  • isDynamic(): boolean

  • Sets whether the link remote terminus to be used should indicate it is 'dynamic', requesting the peer names it with a dynamic address. The address provided by the peer can then be inspected using {@link ProtonLink#getRemoteAddress} (or inspecting the remote terminus details directly) after the link has remotely opened.

    Returns boolean

setDynamic

  • Sets whether the link remote terminus to be used should indicate it is 'dynamic', requesting the peer names it with a dynamic address. The address provided by the peer can then be inspected using {@link ProtonLink#getRemoteAddress} (or inspecting the remote terminus details directly) after the link has remotely opened.

    Parameters

    • dynamic: boolean

    Returns ProtonLinkOptions

setLinkName

  • Parameters

    • linkName: string

    Returns ProtonLinkOptions

toJson

  • toJson(): {}

  • Returns {}

    • [key: string]: any

Generated using TypeDoc