@audiotool/nexus - v0.0.12
    Preparing search index...

    Class ListSamplesRequestGenerated

    Request for SampleService.ListSamples.

    from message audiotool.sample.v1.ListSamplesRequest

    Hierarchy

    Index

    Constructors

    Properties

    filter: string = ""

    The standard CEL filter.

    Supported fields:

    • sample.name
    • sample.display_name
    • sample.description
    • sample.owner_name
    • sample.num_favorites
    • sample.num_usages
    • sample.bpm
    • sample.sample_type
    • sample.play_duration
    • sample.create_time
    • sample.update_time
    • sample.clearance
    • sample.tags
    • sample.favorited_by_user

    from field: string filter = 4;

    orderBy: string = ""

    The order to sort the results by.

    Supported fields:

    • sample.name
    • sample.display_name
    • sample.description
    • sample.owner_name
    • sample.num_favorites
    • sample.num_usages
    • sample.bpm
    • sample.sample_type
    • sample.play_duration
    • sample.create_time
    • sample.update_time
    • sample.clearance
    • sample.tags

    from field: string order_by = 5;

    pageSize: number = 0

    The maximum number of items to return.

    from field: int32 page_size = 2;

    pageToken: string = ""

    The next_page_token value returned from a previous List request, if any.

    from field: string page_token = 3;

    textSearch: string = ""

    An additional filter for matching text metadata

    Examples: 'kepz & dub' : returns results matching both keywords 'guitar & (jazz | funk)' : returns guitar samples tagged with either jazz or funk '!bass & guitar & (jazz | funk)' : same as above but excludes samples matching "bass"

    from field: string text_search = 6;

    fields: FieldList = ...
    runtime: ProtoRuntime = proto3
    typeName: "audiotool.sample.v1.ListSamplesRequest"

    Methods

    • 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

      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<ListSamplesRequest>

    • 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