JSDoc: Class: StreamOrderBookL2ResponseV1

new StreamOrderBookL2ResponseV1(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/orderbookl2_v1/response_pb.js, line 42

Extends

jspb.Message

Members

(static) displayName

Source:

stream/orderbookl2_v1/response_pb.js, line 51

Methods

addAsks(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.kaikosdk.Order}

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.kaikosdk.Order	<optional>
`opt_index`	number	<optional>

Source:

stream/orderbookl2_v1/response_pb.js, line 417

Returns:

Type: proto.kaikosdk.Order

addBids(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.kaikosdk.Order}

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.kaikosdk.Order	<optional>
`opt_index`	number	<optional>

Source:

stream/orderbookl2_v1/response_pb.js, line 455

Returns:

Type: proto.kaikosdk.Order

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

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

Source:

stream/orderbookl2_v1/response_pb.js, line 597

Returns:

returns this

Type: proto.kaikosdk.StreamOrderBookL2ResponseV1

clearAsksList() → (non-null) {proto.kaikosdk.StreamOrderBookL2ResponseV1}

Clears the list making it empty but non-null.

Source:

stream/orderbookl2_v1/response_pb.js, line 426

Returns:

returns this

Type: proto.kaikosdk.StreamOrderBookL2ResponseV1

clearBidsList() → (non-null) {proto.kaikosdk.StreamOrderBookL2ResponseV1}

Clears the list making it empty but non-null.

Source:

stream/orderbookl2_v1/response_pb.js, line 464

Returns:

returns this

Type: proto.kaikosdk.StreamOrderBookL2ResponseV1

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

Clears the message field making it undefined.

Source:

stream/orderbookl2_v1/response_pb.js, line 529

Returns:

returns this

Type: proto.kaikosdk.StreamOrderBookL2ResponseV1

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

Clears the message field making it undefined.

Source:

stream/orderbookl2_v1/response_pb.js, line 566

Returns:

returns this

Type: proto.kaikosdk.StreamOrderBookL2ResponseV1

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

Clears the message field making it undefined.

Source:

stream/orderbookl2_v1/response_pb.js, line 492

Returns:

returns this

Type: proto.kaikosdk.StreamOrderBookL2ResponseV1

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

map additional_properties = 11;

Parameters:

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

Source:

stream/orderbookl2_v1/response_pb.js, line 586

Returns:

Type: jspb.Map.<string, string>

getAsksList() → (non-null) {Array.<!proto.kaikosdk.Order>}

repeated Order asks = 6;

Source:

stream/orderbookl2_v1/response_pb.js, line 397

Returns:

Type: Array.<!proto.kaikosdk.Order>

getBidsList() → (non-null) {Array.<!proto.kaikosdk.Order>}

repeated Order bids = 7;

Source:

stream/orderbookl2_v1/response_pb.js, line 435

Returns:

Type: Array.<!proto.kaikosdk.Order>

getClass() → {string}

optional string class = 1;

Source:

stream/orderbookl2_v1/response_pb.js, line 307

Returns:

Type: string

getCode() → {string}

optional string code = 2;

Source:

stream/orderbookl2_v1/response_pb.js, line 325

Returns:

Type: string

getExchange() → {string}

optional string exchange = 3;

Source:

stream/orderbookl2_v1/response_pb.js, line 343

Returns:

Type: string

getSequenceId() → {string}

optional string sequence_id = 4;

Source:

stream/orderbookl2_v1/response_pb.js, line 361

Returns:

Type: string

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

optional TimestampValue ts_collection = 9;

Source:

stream/orderbookl2_v1/response_pb.js, line 510

Returns:

Type: proto.kaikosdk.TimestampValue

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

optional google.protobuf.Timestamp ts_event = 10;

Source:

stream/orderbookl2_v1/response_pb.js, line 547

Returns:

Type: proto.google.protobuf.Timestamp

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

optional TimestampValue ts_exchange = 8;

Source:

stream/orderbookl2_v1/response_pb.js, line 473

Returns:

Type: proto.kaikosdk.TimestampValue

getUpdateType() → (non-null) {proto.kaikosdk.StreamOrderBookL2UpdateType}

optional StreamOrderBookL2UpdateType update_type = 5;

Source:

stream/orderbookl2_v1/response_pb.js, line 379

Returns:

Type: proto.kaikosdk.StreamOrderBookL2UpdateType

hasTsCollection() → {boolean}

Returns whether this field is set.

Source:

stream/orderbookl2_v1/response_pb.js, line 538

Returns:

Type: boolean

hasTsEvent() → {boolean}

Returns whether this field is set.

Source:

stream/orderbookl2_v1/response_pb.js, line 575

Returns:

Type: boolean

hasTsExchange() → {boolean}

Returns whether this field is set.

Source:

stream/orderbookl2_v1/response_pb.js, line 501

Returns:

Type: boolean

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

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

Source:

stream/orderbookl2_v1/response_pb.js, line 205

Returns:

Type: Uint8Array

setAsksList(valuenon-null) → (non-null) {proto.kaikosdk.StreamOrderBookL2ResponseV1}

Parameters:

Name	Type	Description
`value`	Array.<!proto.kaikosdk.Order>

Source:

stream/orderbookl2_v1/response_pb.js, line 407

Returns:

returns this

Type: proto.kaikosdk.StreamOrderBookL2ResponseV1

setBidsList(valuenon-null) → (non-null) {proto.kaikosdk.StreamOrderBookL2ResponseV1}

Parameters:

Name	Type	Description
`value`	Array.<!proto.kaikosdk.Order>

Source:

stream/orderbookl2_v1/response_pb.js, line 445

Returns:

returns this

Type: proto.kaikosdk.StreamOrderBookL2ResponseV1

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

Parameters:

Name	Type	Description
`value`	string

Source:

stream/orderbookl2_v1/response_pb.js, line 316

Returns:

returns this

Type: proto.kaikosdk.StreamOrderBookL2ResponseV1

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

Parameters:

Name	Type	Description
`value`	string

Source:

stream/orderbookl2_v1/response_pb.js, line 334

Returns:

returns this

Type: proto.kaikosdk.StreamOrderBookL2ResponseV1

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

Parameters:

Name	Type	Description
`value`	string

Source:

stream/orderbookl2_v1/response_pb.js, line 352

Returns:

returns this

Type: proto.kaikosdk.StreamOrderBookL2ResponseV1

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

Parameters:

Name	Type	Description
`value`	string

Source:

stream/orderbookl2_v1/response_pb.js, line 370

Returns:

returns this

Type: proto.kaikosdk.StreamOrderBookL2ResponseV1

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

Parameters:

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

Source:

stream/orderbookl2_v1/response_pb.js, line 520

Returns:

returns this

Type: proto.kaikosdk.StreamOrderBookL2ResponseV1

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

Parameters:

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

Source:

stream/orderbookl2_v1/response_pb.js, line 557

Returns:

returns this

Type: proto.kaikosdk.StreamOrderBookL2ResponseV1

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

Parameters:

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

Source:

stream/orderbookl2_v1/response_pb.js, line 483

Returns:

returns this

Type: proto.kaikosdk.StreamOrderBookL2ResponseV1

setUpdateType(valuenon-null) → (non-null) {proto.kaikosdk.StreamOrderBookL2ResponseV1}

Parameters:

Name	Type	Description
`value`	proto.kaikosdk.StreamOrderBookL2UpdateType

Source:

stream/orderbookl2_v1/response_pb.js, line 388

Returns:

returns this

Type: proto.kaikosdk.StreamOrderBookL2ResponseV1

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/orderbookl2_v1/response_pb.js, line 76

Returns:

Type: Object

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

Deserializes binary data (in protobuf wire format).

Parameters:

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

Source:

stream/orderbookl2_v1/response_pb.js, line 120

Returns:

Type: proto.kaikosdk.StreamOrderBookL2ResponseV1

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

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

Parameters:

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

Source:

stream/orderbookl2_v1/response_pb.js, line 134

Returns:

Type: proto.kaikosdk.StreamOrderBookL2ResponseV1

(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.StreamOrderBookL2ResponseV1
`writer`	jspb.BinaryWriter

Source:

stream/orderbookl2_v1/response_pb.js, line 219

(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.StreamOrderBookL2ResponseV1	The msg instance to transform.

Source:

stream/orderbookl2_v1/response_pb.js, line 90

Returns:

Type: Object