Options
All
  • Public
  • Public/Protected
  • All
Menu

PinsApi - interface

export
interface

PinsApiInterface

Hierarchy

  • PinsApiInterface

Implemented by

Index

Methods

pinsGet

  • List all the pin objects, matching optional filters; when no filter is provided, only successful pins are returned List pin objects

    Parameters

    Returns Promise<PinResults>

pinsGetRaw

  • List all the pin objects, matching optional filters; when no filter is provided, only successful pins are returned

    summary

    List pin objects

    throws

    {RequiredError}

    memberof

    PinsApiInterface

    Parameters

    Returns Promise<ApiResponse<PinResults>>

pinsPost

  • Add a new pin object for the current access token Add pin object

    Parameters

    Returns Promise<PinStatus>

pinsPostRaw

  • Add a new pin object for the current access token

    summary

    Add pin object

    throws

    {RequiredError}

    memberof

    PinsApiInterface

    Parameters

    Returns Promise<ApiResponse<PinStatus>>

pinsRequestidDelete

pinsRequestidDeleteRaw

pinsRequestidGet

pinsRequestidGetRaw

pinsRequestidPost

  • Replace an existing pin object (shortcut for executing remove and add operations in one step to avoid unnecessary garbage collection of blocks present in both recursive pins) Replace pin object

    Parameters

    Returns Promise<PinStatus>

pinsRequestidPostRaw

  • Replace an existing pin object (shortcut for executing remove and add operations in one step to avoid unnecessary garbage collection of blocks present in both recursive pins)

    summary

    Replace pin object

    throws

    {RequiredError}

    memberof

    PinsApiInterface

    Parameters

    Returns Promise<ApiResponse<PinStatus>>