Viam SDK
    Preparing search index...

    Class NavigateRouteRequest

    from message viam.service.navigation.v1.NavigateRouteRequest

    Hierarchy

    Index
    constructor
    extra? loop name routeName startIndex startNearest wait waypoints fields runtime typeName
    clone equals fromBinary fromJson fromJsonString getType toBinary toJson toJSON toJsonString equals fromBinary fromJson fromJsonString
    extra?: Struct

    from field: google.protobuf.Struct extra = 99;

    loop: boolean

    Optional; default false

    from field: bool loop = 6;

    name: string

    Name of the navigation service

    from field: string name = 1;

    routeName: string

    Optional; a saved route

    from field: string route_name = 2;

    startIndex: number

    Optional; default 0

    from field: uint32 start_index = 4;

    startNearest: boolean

    Optional; overrides start_index

    from field: bool start_nearest = 5;

    wait: boolean

    Optional; default false. With loop, only returns when stopped

    from field: bool wait = 7;

    waypoints: navigationApi.Waypoint[]

    Optional; inline waypoints

    from field: repeated viam.service.navigation.v1.Waypoint waypoints = 3;

    fields: FieldList
    runtime: ProtoRuntime
    typeName: "viam.service.navigation.v1.NavigateRouteRequest"

    • Parse from binary data, merging fields.

      Repeated fields are appended. Map entries are added, overwriting existing keys.

      If a message field is already present, it will be merged with the new data.

      Parameters

      • bytes: Uint8Array
      • Optionaloptions: Partial<BinaryReadOptions>

      Returns this

    • Parse a message from a JSON value.

      Parameters

      • jsonValue: JsonValue
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Parse a message from a JSON string.

      Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

      Returns MessageType<NavigateRouteRequest>

    • Serialize the message to binary data.

      Parameters

      • Optionaloptions: Partial<BinaryWriteOptions>

      Returns Uint8Array

    • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

      Parameters

      • Optionaloptions: Partial<JsonWriteOptions>

      Returns JsonValue

    • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

      Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

      This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

      Returns JsonValue

    • Serialize the message to a JSON string.

      Parameters

      • Optionaloptions: Partial<JsonWriteStringOptions>

      Returns string

    • Parameters

      • bytes: Uint8Array
      • Optionaloptions: Partial<BinaryReadOptions>

      Returns NavigateRouteRequest

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns NavigateRouteRequest

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods