Viam SDK
    Preparing search index...

    Class App

    from message viam.app.v1.App

    Hierarchy

    • Message<App>
      • App
    Index

    Constructors

    • Parameters

      • Optionaldata: PartialMessage<App>

      Returns App

    Properties

    allowedOrgIds?: AllowedOrgIDs

    Optional: list of org IDs that are allowed to use this app; if empty, all orgs are allowed

    from field: optional viam.app.v1.AllowedOrgIDs allowed_org_ids = 7;

    customizations?: AppCustomizations

    Optional: structured customizations for the app (e.g., machine picker headings)

    from field: viam.app.v1.AppCustomizations customizations = 6;

    entrypoint: string

    The entrypoint of the application

    from field: string entrypoint = 3;

    fragmentIds: string[]

    Optional: fragment IDs to filter machines in the picker

    from field: repeated string fragment_ids = 4;

    logoPath?: string

    Optional: path to a custom logo for branding

    from field: optional string logo_path = 5;

    name: string

    The name of the application

    from field: string name = 1;

    type: string

    The type of the application

    from field: string type = 2;

    fields: FieldList
    runtime: ProtoRuntime
    typeName: "viam.app.v1.App"

    Methods

    • Create a deep copy.

      Returns App

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

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

    • Parameters

      • jsonValue: JsonValue
      • Optionaloptions: Partial<JsonReadOptions>

      Returns App

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns App