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

    Class SettingsGenerated

    The settings of the user.

    from message audiotool.user.v1.Settings

    Hierarchy

    Index

    Constructors

    Properties

    allowLinksOnPlaylistComments: boolean = false

    Whether to allow links posted in comments on playlists.

    from field: bool allow_links_on_playlist_comments = 9;

    allowLinksOnTrackComments: boolean = false

    Whether to allow links posted in comments on tracks.

    from field: bool allow_links_on_track_comments = 8;

    allowLinksOnUserPageComments: boolean = false

    Whether to allow links posted in comments on user page.

    from field: bool allow_links_on_user_page_comments = 7;

    defaultPlaylistCommentMode: CommentMode = CommentMode.UNSPECIFIED

    The mode of the comments on the user's playlists.

    from field: audiotool.user.v1.CommentMode default_playlist_comment_mode = 3;

    defaultTrackCommentMode: CommentMode = CommentMode.UNSPECIFIED

    The mode of the comments on the user's tracks.

    from field: audiotool.user.v1.CommentMode default_track_comment_mode = 2;

    newsletterSubscriber: boolean = false

    User is subscribed to the Audiotool newsletter.

    from field: bool newsletter_subscriber = 6;

    showAsListener: boolean = false

    Show as listener of tracks.

    from field: bool show_as_listener = 5;

    showOnlineStatus: boolean = false

    Show online status.

    from field: bool show_online_status = 4;

    userPageCommentMode: CommentMode = CommentMode.UNSPECIFIED

    The mode of the comments user's page.

    from field: audiotool.user.v1.CommentMode user_page_comment_mode = 1;

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

    Methods

    • Create a deep copy.

      Returns Settings

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

    • 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