Viam SDK
    Preparing search index...

    Class ListRegistryItemsRequest

    from message viam.app.v1.ListRegistryItemsRequest

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    includeMarkdownDocumentation? moduleLanguages moduleSourceTypes organizationId? pageToken? platforms publicNamespaces searchTerm? showOwnedDeprecated? statuses types visibilities fields runtime typeName

    Methods

    clone equals fromBinary fromJson fromJsonString getType toBinary toJson toJSON toJsonString equals fromBinary fromJson fromJsonString

    Constructors

    Properties

    includeMarkdownDocumentation?: boolean

    from field: optional bool include_markdown_documentation = 9;

    moduleLanguages: ModuleLanguage[]

    from field: repeated viam.app.v1.ModuleLanguage module_languages = 11;

    moduleSourceTypes: ModuleSourceType[]

    from field: repeated viam.app.v1.ModuleSourceType module_source_types = 10;

    organizationId?: string

    The id of the organization to return registry items for.

    from field: optional string organization_id = 1;

    pageToken?: string

    from field: optional string page_token = 7;

    platforms: string[]

    from field: repeated string platforms = 4;

    publicNamespaces: string[]

    One or more public namespaces to return results for.

    from field: repeated string public_namespaces = 8;

    searchTerm?: string

    from field: optional string search_term = 6;

    showOwnedDeprecated?: boolean

    from field: optional bool show_owned_deprecated = 12;

    statuses: RegistryItemStatus[]

    from field: repeated viam.app.v1.RegistryItemStatus statuses = 5;

    types: PackageType[]

    from field: repeated viam.app.packages.v1.PackageType types = 2;

    visibilities: Visibility[]

    from field: repeated viam.app.v1.Visibility visibilities = 3;

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

    Methods

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

    • 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

    Constructors
    Properties
    Methods