JSDoc: Class: StreamTradesResponseV1

new StreamTradesResponseV1(opt_dataopt)

Generated by JsPbCodeGenerator.

Parameters:

Name	Type	Attributes	Description
`opt_data`	Array	<optional>	Optional initial data array, typically from a server response, or constructed directly in Javascript. The array is used in place and becomes part of the constructed object. It is not cloned. If no data is provided, the constructed object will be empty, but still valid.

Source:

stream/trades_v1/response_pb.js, line 40

Extends

jspb.Message

Members

(static) displayName

Source:

stream/trades_v1/response_pb.js, line 49

(static) TradeSide :number

Type:

number

Properties:

Name	Type	Description
`UNKNOWN`	number
`BUY`	number
`SELL`	number

Source:

stream/trades_v1/response_pb.js, line 303

Methods

clearAdditionalPropertiesMap() → (non-null) {proto.kaikosdk.StreamTradesResponseV1}

Clears values from the map. The map will be non-null.

Source:

stream/trades_v1/response_pb.js, line 326

Returns:

returns this

Type: proto.kaikosdk.StreamTradesResponseV1

clearTsCollection() → (non-null) {proto.kaikosdk.StreamTradesResponseV1}

Clears the message field making it undefined.

Source:

stream/trades_v1/response_pb.js, line 536

Returns:

returns this

Type: proto.kaikosdk.StreamTradesResponseV1

clearTsEvent() → (non-null) {proto.kaikosdk.StreamTradesResponseV1}

Clears the message field making it undefined.

Source:

stream/trades_v1/response_pb.js, line 573

Returns:

returns this

Type: proto.kaikosdk.StreamTradesResponseV1

clearTsExchange() → (non-null) {proto.kaikosdk.StreamTradesResponseV1}

Clears the message field making it undefined.

Source:

stream/trades_v1/response_pb.js, line 499

Returns:

returns this

Type: proto.kaikosdk.StreamTradesResponseV1

getAdditionalPropertiesMap(opt_noLazyCreateopt) → (non-null) {jspb.Map.<string, string>}

map additional_properties = 1;

Parameters:

Name	Type	Attributes	Description
`opt_noLazyCreate`	boolean	<optional>	Do not create the map if empty, instead returning `undefined`

Source:

stream/trades_v1/response_pb.js, line 315

Returns:

Type: jspb.Map.<string, string>

getAmount() → {number}

optional double amount = 2;

Source:

stream/trades_v1/response_pb.js, line 336

Returns:

Type: number

getClass() → {string}

optional string class = 3;

Source:

stream/trades_v1/response_pb.js, line 354

Returns:

Type: string

getCode() → {string}

optional string code = 4;

Source:

stream/trades_v1/response_pb.js, line 372

Returns:

Type: string

getExchange() → {string}

optional string exchange = 5;

Source:

stream/trades_v1/response_pb.js, line 390

Returns:

Type: string

getId() → {string}

optional string id = 7;

Source:

stream/trades_v1/response_pb.js, line 426

Returns:

Type: string

getPrice() → {number}

optional double price = 8;

Source:

stream/trades_v1/response_pb.js, line 444

Returns:

Type: number

getSequenceId() → {string}

optional string sequence_id = 6;

Source:

stream/trades_v1/response_pb.js, line 408

Returns:

Type: string

getSide() → (non-null) {proto.kaikosdk.StreamTradesResponseV1.TradeSide}

optional TradeSide side = 9;

Source:

stream/trades_v1/response_pb.js, line 462

Returns:

Type: proto.kaikosdk.StreamTradesResponseV1.TradeSide

getTsCollection() → (nullable) {proto.kaikosdk.TimestampValue}

optional TimestampValue ts_collection = 11;

Source:

stream/trades_v1/response_pb.js, line 517

Returns:

Type: proto.kaikosdk.TimestampValue

getTsEvent() → (nullable) {proto.google.protobuf.Timestamp}

optional google.protobuf.Timestamp ts_event = 12;

Source:

stream/trades_v1/response_pb.js, line 554

Returns:

Type: proto.google.protobuf.Timestamp

getTsExchange() → (nullable) {proto.kaikosdk.TimestampValue}

optional TimestampValue ts_exchange = 10;

Source:

stream/trades_v1/response_pb.js, line 480

Returns:

Type: proto.kaikosdk.TimestampValue

hasTsCollection() → {boolean}

Returns whether this field is set.

Source:

stream/trades_v1/response_pb.js, line 545

Returns:

Type: boolean

hasTsEvent() → {boolean}

Returns whether this field is set.

Source:

stream/trades_v1/response_pb.js, line 582

Returns:

Type: boolean

hasTsExchange() → {boolean}

Returns whether this field is set.

Source:

stream/trades_v1/response_pb.js, line 508

Returns:

Type: boolean

serializeBinary() → (non-null) {Uint8Array}

Serializes the message to binary data (in protobuf wire format).

Source:

stream/trades_v1/response_pb.js, line 197

Returns:

Type: Uint8Array

setAmount(value) → (non-null) {proto.kaikosdk.StreamTradesResponseV1}

Parameters:

Name	Type	Description
`value`	number

Source:

stream/trades_v1/response_pb.js, line 345

Returns:

returns this

Type: proto.kaikosdk.StreamTradesResponseV1

setClass(value) → (non-null) {proto.kaikosdk.StreamTradesResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/trades_v1/response_pb.js, line 363

Returns:

returns this

Type: proto.kaikosdk.StreamTradesResponseV1

setCode(value) → (non-null) {proto.kaikosdk.StreamTradesResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/trades_v1/response_pb.js, line 381

Returns:

returns this

Type: proto.kaikosdk.StreamTradesResponseV1

setExchange(value) → (non-null) {proto.kaikosdk.StreamTradesResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/trades_v1/response_pb.js, line 399

Returns:

returns this

Type: proto.kaikosdk.StreamTradesResponseV1

setId(value) → (non-null) {proto.kaikosdk.StreamTradesResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/trades_v1/response_pb.js, line 435

Returns:

returns this

Type: proto.kaikosdk.StreamTradesResponseV1

setPrice(value) → (non-null) {proto.kaikosdk.StreamTradesResponseV1}

Parameters:

Name	Type	Description
`value`	number

Source:

stream/trades_v1/response_pb.js, line 453

Returns:

returns this

Type: proto.kaikosdk.StreamTradesResponseV1

setSequenceId(value) → (non-null) {proto.kaikosdk.StreamTradesResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/trades_v1/response_pb.js, line 417

Returns:

returns this

Type: proto.kaikosdk.StreamTradesResponseV1

setSide(valuenon-null) → (non-null) {proto.kaikosdk.StreamTradesResponseV1}

Parameters:

Name	Type	Description
`value`	proto.kaikosdk.StreamTradesResponseV1.TradeSide

Source:

stream/trades_v1/response_pb.js, line 471

Returns:

returns this

Type: proto.kaikosdk.StreamTradesResponseV1

setTsCollection(value) → (non-null) {proto.kaikosdk.StreamTradesResponseV1}

Parameters:

Name	Type	Description
`value`	proto.kaikosdk.TimestampValue \| undefined

Source:

stream/trades_v1/response_pb.js, line 527

Returns:

returns this

Type: proto.kaikosdk.StreamTradesResponseV1

setTsEvent(value) → (non-null) {proto.kaikosdk.StreamTradesResponseV1}

Parameters:

Name	Type	Description
`value`	proto.google.protobuf.Timestamp \| undefined

Source:

stream/trades_v1/response_pb.js, line 564

Returns:

returns this

Type: proto.kaikosdk.StreamTradesResponseV1

setTsExchange(value) → (non-null) {proto.kaikosdk.StreamTradesResponseV1}

Parameters:

Name	Type	Description
`value`	proto.kaikosdk.TimestampValue \| undefined

Source:

stream/trades_v1/response_pb.js, line 490

Returns:

returns this

Type: proto.kaikosdk.StreamTradesResponseV1

toObject(opt_includeInstanceopt) → (non-null) {Object}

Creates an object representation of this proto. Field names that are reserved in JavaScript and will be renamed to pb_name. Optional fields that are not set will be set to undefined. To access a reserved field use, foo.pb_, eg, foo.pb_default. For the list of reserved names please see: net/proto2/compiler/js/internal/generator.cc#kKeyword.

Parameters:

Name	Type	Attributes	Description
`opt_includeInstance`	boolean	<optional>	Deprecated. whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration

Source:

stream/trades_v1/response_pb.js, line 67

Returns:

Type: Object

(static) deserializeBinary(bytes) → (non-null) {proto.kaikosdk.StreamTradesResponseV1}

Deserializes binary data (in protobuf wire format).

Parameters:

Name	Type	Description
`bytes`	jspb.ByteSource	The bytes to deserialize.

Source:

stream/trades_v1/response_pb.js, line 110

Returns:

Type: proto.kaikosdk.StreamTradesResponseV1

(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.kaikosdk.StreamTradesResponseV1}

Deserializes binary data (in protobuf wire format) from the given reader into the given message object.

Parameters:

Name	Type	Description
`msg`	proto.kaikosdk.StreamTradesResponseV1	The message object to deserialize into.
`reader`	jspb.BinaryReader	The BinaryReader to use.

Source:

stream/trades_v1/response_pb.js, line 124

Returns:

Type: proto.kaikosdk.StreamTradesResponseV1

(static) serializeBinaryToWriter(messagenon-null, writernon-null)

Serializes the given message to binary data (in protobuf wire format), writing to the given BinaryWriter.

Parameters:

Name	Type	Description
`message`	proto.kaikosdk.StreamTradesResponseV1
`writer`	jspb.BinaryWriter

Source:

stream/trades_v1/response_pb.js, line 211

(static) toObject(includeInstance, msgnon-null) → (non-null) {Object}

Static version of the {@see toObject} method.

Parameters:

Name	Type	Description
`includeInstance`	boolean \| undefined	Deprecated. Whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration
`msg`	proto.kaikosdk.StreamTradesResponseV1	The msg instance to transform.

Source:

stream/trades_v1/response_pb.js, line 81

Returns:

Type: Object