Viam SDK
    Preparing search index...

    Interface BinaryID

    BinaryID is the unique identifier for a file that one can request to be retrieved or modified.

    from message viam.app.data.v1.BinaryID

    interface BinaryID {
        fileId: string;
        locationId: string;
        organizationId: string;
        clone(): BinaryID;
        equals(
            other: BinaryID | PlainMessage<BinaryID> | null | undefined,
        ): boolean;
        fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): this;
        fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): this;
        fromJsonString(
            jsonString: string,
            options?: Partial<JsonReadOptions>,
        ): this;
        getType(): MessageType<BinaryID>;
        toBinary(options?: Partial<BinaryWriteOptions>): Uint8Array;
        toJson(options?: Partial<JsonWriteOptions>): JsonValue;
        toJSON(): JsonValue;
        toJsonString(options?: Partial<JsonWriteStringOptions>): string;
    }

    Hierarchy

    Index
    fileId locationId organizationId
    clone equals fromBinary fromJson fromJsonString getType toBinary toJson toJSON toJsonString
    fileId: string

    from field: string file_id = 1;

    locationId: string

    from field: string location_id = 3;

    organizationId: string

    from field: string organization_id = 2;

    • Create a deep copy.

      Returns BinaryID

    • Compare with a message of the same type. Note that this function disregards extensions and unknown fields.

      Parameters

      Returns boolean

    • 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<BinaryID>

    • 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

    Settings
    Member Visibility

    On This Page
    Properties
    Methods