snapcar-sdk-js

  • API Docs for Version: 1.0.0

    • Show:

    SnapCar.SpecialArea

    Describes an area with specific meeting points that the rider may select to help him finding his driver at specific pick up locations.

    Table of Contents

    Constructor

    SnapCar.SpecialArea ()

    Defined in dist/SnapCar.js:826

    Properties

    areaType

    String const

    Defined in dist/SnapCar.js:900

    The type of special area. Can either be a station, an airport or a regular area. Refer to the SnapCar.SpecialAreaTypes values.

    Example:

     "airport"

    id

    String const

    Defined in dist/SnapCar.js:858

    Unique identifier.

    meetingPoints

    Array const

    Defined in dist/SnapCar.js:912

    An array of meeting points in which the user can select his preferred one if the user hasn't enabled the nameboard option.

    meetingPointsNameboard

    Array const

    Defined in dist/SnapCar.js:922

    An array of meeting points in which the user can select his preferred one if the user has enabled the nameboard option.

    menuName

    String const

    Defined in dist/SnapCar.js:878

    Localized short value that describes the kind of meeting points that can be selected.

    Example:

     "Terminal"

    name

    String const

    Defined in dist/SnapCar.js:868

    Localized short name that briefly describes the area.

    selectionRequired

    Boolean const

    Defined in dist/SnapCar.js:890

    Indicates if the user is required to select a meeting point for this area.