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

    Class UserGenerated

    A user of audiotool.

    from message audiotool.user.v1.User

    Hierarchy

    Index

    Constructors

    Properties

    artistPageHeaderUrl: string = ""

    The artist page header (banner) URL of the user.

    The artist_page_header_url will be in the form of:

    "https://.../1440x300.webp?{SHA}"

    The SHA can be used for cache busting.

    If you need another resolution you can replace 1440x300.webp with:

    • 2880x600.webp
    • 960x200.webp

    from field: string artist_page_header_url = 12;

    avatarUrl: string = ""

    The avatar URL of the user.

    The avatar_url will be in the form of:

    "https://.../300x300.webp?{SHA}"

    The SHA can be used for cache busting.

    If you need another resolution you can replace 300x300.webp with:

    • 30x30.webp
    • 60x60.webp
    • 120x120.webp
    • 300x300.webp
    • 600x600.webp

    from field: string avatar_url = 10;

    createTime?: Timestamp

    Output only. Timestamp when this User was created.

    from field: google.protobuf.Timestamp create_time = 3;

    description: string = ""

    The description of the user.

    from field: string description = 4;

    displayName: string = ""

    The name of the user.

    from field: string display_name = 2;

    links: string[] = []

    The links of the user

    from field: repeated string links = 11;

    name: string = ""

    The unique name of the user.

    from field: string name = 1;

    numAlbums: number = 0

    The number of public albums the user has.

    from field: int32 num_albums = 6;

    numFollowers: number = 0

    The number of followers the user has.

    from field: int32 num_followers = 7;

    numFollowing: number = 0

    The number of users the user is following.

    from field: int32 num_following = 8;

    numTracks: number = 0

    The number of total tracks the user is credited on. To see number of public tracks, you can get the count from the users published playlist. Can be found at users/{user}/playlists/published

    from field: int32 num_tracks = 5;

    tags: string[] = []

    The tags of the user

    from field: repeated string tags = 9;

    fields: FieldList = ...
    runtime: ProtoRuntime = proto3
    typeName: "audiotool.user.v1.User"

    Methods

    • Create a deep copy.

      Returns User

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

      Parameters

      • other: undefined | null | User | PlainMessage<User>

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

    • 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