UNPKG

spot-sdk-js

Version:

Develop applications and payloads for Spot using the unofficial Boston Dynamics Spot Node.js SDK.

561 lines (485 loc) 16.7 kB
// source: bosdyn/api/auth.proto /** * @fileoverview * @enhanceable * @suppress {missingRequire} reports error on implicit type usages. * @suppress {messageConventions} JS Compiler reports an error if a variable or * field starts with 'MSG_' and isn't a translatable message. * @public */ // GENERATED CODE -- DO NOT EDIT! /* eslint-disable */ // @ts-nocheck var jspb = require('google-protobuf'); var goog = jspb; var global = Function('return this')(); var bosdyn_api_header_pb = require('../../bosdyn/api/header_pb.js'); goog.object.extend(proto, bosdyn_api_header_pb); goog.exportSymbol('proto.bosdyn.api.GetAuthTokenRequest', null, global); goog.exportSymbol('proto.bosdyn.api.GetAuthTokenResponse', null, global); goog.exportSymbol('proto.bosdyn.api.GetAuthTokenResponse.Status', null, global); /** * Generated by JsPbCodeGenerator. * @param {Array=} opt_data 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. * @extends {jspb.Message} * @constructor */ proto.bosdyn.api.GetAuthTokenRequest = function(opt_data) { jspb.Message.initialize(this, opt_data, 0, -1, null, null); }; goog.inherits(proto.bosdyn.api.GetAuthTokenRequest, jspb.Message); if (goog.DEBUG && !COMPILED) { /** * @public * @override */ proto.bosdyn.api.GetAuthTokenRequest.displayName = 'proto.bosdyn.api.GetAuthTokenRequest'; } /** * Generated by JsPbCodeGenerator. * @param {Array=} opt_data 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. * @extends {jspb.Message} * @constructor */ proto.bosdyn.api.GetAuthTokenResponse = function(opt_data) { jspb.Message.initialize(this, opt_data, 0, -1, null, null); }; goog.inherits(proto.bosdyn.api.GetAuthTokenResponse, jspb.Message); if (goog.DEBUG && !COMPILED) { /** * @public * @override */ proto.bosdyn.api.GetAuthTokenResponse.displayName = 'proto.bosdyn.api.GetAuthTokenResponse'; } if (jspb.Message.GENERATE_TO_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_<name>, eg, foo.pb_default. * For the list of reserved names please see: * net/proto2/compiler/js/internal/generator.cc#kKeyword. * @param {boolean=} opt_includeInstance Deprecated. whether to include the * JSPB instance for transitional soy proto support: * http://goto/soy-param-migration * @return {!Object} */ proto.bosdyn.api.GetAuthTokenRequest.prototype.toObject = function(opt_includeInstance) { return proto.bosdyn.api.GetAuthTokenRequest.toObject(opt_includeInstance, this); }; /** * Static version of the {@see toObject} method. * @param {boolean|undefined} includeInstance Deprecated. Whether to include * the JSPB instance for transitional soy proto support: * http://goto/soy-param-migration * @param {!proto.bosdyn.api.GetAuthTokenRequest} msg The msg instance to transform. * @return {!Object} * @suppress {unusedLocalVariables} f is only used for nested messages */ proto.bosdyn.api.GetAuthTokenRequest.toObject = function(includeInstance, msg) { var f, obj = { header: (f = msg.getHeader()) && bosdyn_api_header_pb.RequestHeader.toObject(includeInstance, f), username: jspb.Message.getFieldWithDefault(msg, 2, ""), password: jspb.Message.getFieldWithDefault(msg, 3, ""), token: jspb.Message.getFieldWithDefault(msg, 4, ""), applicationToken: jspb.Message.getFieldWithDefault(msg, 5, "") }; if (includeInstance) { obj.$jspbMessageInstance = msg; } return obj; }; } /** * Deserializes binary data (in protobuf wire format). * @param {jspb.ByteSource} bytes The bytes to deserialize. * @return {!proto.bosdyn.api.GetAuthTokenRequest} */ proto.bosdyn.api.GetAuthTokenRequest.deserializeBinary = function(bytes) { var reader = new jspb.BinaryReader(bytes); var msg = new proto.bosdyn.api.GetAuthTokenRequest; return proto.bosdyn.api.GetAuthTokenRequest.deserializeBinaryFromReader(msg, reader); }; /** * Deserializes binary data (in protobuf wire format) from the * given reader into the given message object. * @param {!proto.bosdyn.api.GetAuthTokenRequest} msg The message object to deserialize into. * @param {!jspb.BinaryReader} reader The BinaryReader to use. * @return {!proto.bosdyn.api.GetAuthTokenRequest} */ proto.bosdyn.api.GetAuthTokenRequest.deserializeBinaryFromReader = function(msg, reader) { while (reader.nextField()) { if (reader.isEndGroup()) { break; } var field = reader.getFieldNumber(); switch (field) { case 1: var value = new bosdyn_api_header_pb.RequestHeader; reader.readMessage(value,bosdyn_api_header_pb.RequestHeader.deserializeBinaryFromReader); msg.setHeader(value); break; case 2: var value = /** @type {string} */ (reader.readString()); msg.setUsername(value); break; case 3: var value = /** @type {string} */ (reader.readString()); msg.setPassword(value); break; case 4: var value = /** @type {string} */ (reader.readString()); msg.setToken(value); break; case 5: var value = /** @type {string} */ (reader.readString()); msg.setApplicationToken(value); break; default: reader.skipField(); break; } } return msg; }; /** * Serializes the message to binary data (in protobuf wire format). * @return {!Uint8Array} */ proto.bosdyn.api.GetAuthTokenRequest.prototype.serializeBinary = function() { var writer = new jspb.BinaryWriter(); proto.bosdyn.api.GetAuthTokenRequest.serializeBinaryToWriter(this, writer); return writer.getResultBuffer(); }; /** * Serializes the given message to binary data (in protobuf wire * format), writing to the given BinaryWriter. * @param {!proto.bosdyn.api.GetAuthTokenRequest} message * @param {!jspb.BinaryWriter} writer * @suppress {unusedLocalVariables} f is only used for nested messages */ proto.bosdyn.api.GetAuthTokenRequest.serializeBinaryToWriter = function(message, writer) { var f = undefined; f = message.getHeader(); if (f != null) { writer.writeMessage( 1, f, bosdyn_api_header_pb.RequestHeader.serializeBinaryToWriter ); } f = message.getUsername(); if (f.length > 0) { writer.writeString( 2, f ); } f = message.getPassword(); if (f.length > 0) { writer.writeString( 3, f ); } f = message.getToken(); if (f.length > 0) { writer.writeString( 4, f ); } f = message.getApplicationToken(); if (f.length > 0) { writer.writeString( 5, f ); } }; /** * optional RequestHeader header = 1; * @return {?proto.bosdyn.api.RequestHeader} */ proto.bosdyn.api.GetAuthTokenRequest.prototype.getHeader = function() { return /** @type{?proto.bosdyn.api.RequestHeader} */ ( jspb.Message.getWrapperField(this, bosdyn_api_header_pb.RequestHeader, 1)); }; /** * @param {?proto.bosdyn.api.RequestHeader|undefined} value * @return {!proto.bosdyn.api.GetAuthTokenRequest} returns this */ proto.bosdyn.api.GetAuthTokenRequest.prototype.setHeader = function(value) { return jspb.Message.setWrapperField(this, 1, value); }; /** * Clears the message field making it undefined. * @return {!proto.bosdyn.api.GetAuthTokenRequest} returns this */ proto.bosdyn.api.GetAuthTokenRequest.prototype.clearHeader = function() { return this.setHeader(undefined); }; /** * Returns whether this field is set. * @return {boolean} */ proto.bosdyn.api.GetAuthTokenRequest.prototype.hasHeader = function() { return jspb.Message.getField(this, 1) != null; }; /** * optional string username = 2; * @return {string} */ proto.bosdyn.api.GetAuthTokenRequest.prototype.getUsername = function() { return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 2, "")); }; /** * @param {string} value * @return {!proto.bosdyn.api.GetAuthTokenRequest} returns this */ proto.bosdyn.api.GetAuthTokenRequest.prototype.setUsername = function(value) { return jspb.Message.setProto3StringField(this, 2, value); }; /** * optional string password = 3; * @return {string} */ proto.bosdyn.api.GetAuthTokenRequest.prototype.getPassword = function() { return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 3, "")); }; /** * @param {string} value * @return {!proto.bosdyn.api.GetAuthTokenRequest} returns this */ proto.bosdyn.api.GetAuthTokenRequest.prototype.setPassword = function(value) { return jspb.Message.setProto3StringField(this, 3, value); }; /** * optional string token = 4; * @return {string} */ proto.bosdyn.api.GetAuthTokenRequest.prototype.getToken = function() { return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 4, "")); }; /** * @param {string} value * @return {!proto.bosdyn.api.GetAuthTokenRequest} returns this */ proto.bosdyn.api.GetAuthTokenRequest.prototype.setToken = function(value) { return jspb.Message.setProto3StringField(this, 4, value); }; /** * optional string application_token = 5; * @return {string} */ proto.bosdyn.api.GetAuthTokenRequest.prototype.getApplicationToken = function() { return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 5, "")); }; /** * @param {string} value * @return {!proto.bosdyn.api.GetAuthTokenRequest} returns this */ proto.bosdyn.api.GetAuthTokenRequest.prototype.setApplicationToken = function(value) { return jspb.Message.setProto3StringField(this, 5, value); }; if (jspb.Message.GENERATE_TO_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_<name>, eg, foo.pb_default. * For the list of reserved names please see: * net/proto2/compiler/js/internal/generator.cc#kKeyword. * @param {boolean=} opt_includeInstance Deprecated. whether to include the * JSPB instance for transitional soy proto support: * http://goto/soy-param-migration * @return {!Object} */ proto.bosdyn.api.GetAuthTokenResponse.prototype.toObject = function(opt_includeInstance) { return proto.bosdyn.api.GetAuthTokenResponse.toObject(opt_includeInstance, this); }; /** * Static version of the {@see toObject} method. * @param {boolean|undefined} includeInstance Deprecated. Whether to include * the JSPB instance for transitional soy proto support: * http://goto/soy-param-migration * @param {!proto.bosdyn.api.GetAuthTokenResponse} msg The msg instance to transform. * @return {!Object} * @suppress {unusedLocalVariables} f is only used for nested messages */ proto.bosdyn.api.GetAuthTokenResponse.toObject = function(includeInstance, msg) { var f, obj = { header: (f = msg.getHeader()) && bosdyn_api_header_pb.ResponseHeader.toObject(includeInstance, f), status: jspb.Message.getFieldWithDefault(msg, 2, 0), token: jspb.Message.getFieldWithDefault(msg, 3, "") }; if (includeInstance) { obj.$jspbMessageInstance = msg; } return obj; }; } /** * Deserializes binary data (in protobuf wire format). * @param {jspb.ByteSource} bytes The bytes to deserialize. * @return {!proto.bosdyn.api.GetAuthTokenResponse} */ proto.bosdyn.api.GetAuthTokenResponse.deserializeBinary = function(bytes) { var reader = new jspb.BinaryReader(bytes); var msg = new proto.bosdyn.api.GetAuthTokenResponse; return proto.bosdyn.api.GetAuthTokenResponse.deserializeBinaryFromReader(msg, reader); }; /** * Deserializes binary data (in protobuf wire format) from the * given reader into the given message object. * @param {!proto.bosdyn.api.GetAuthTokenResponse} msg The message object to deserialize into. * @param {!jspb.BinaryReader} reader The BinaryReader to use. * @return {!proto.bosdyn.api.GetAuthTokenResponse} */ proto.bosdyn.api.GetAuthTokenResponse.deserializeBinaryFromReader = function(msg, reader) { while (reader.nextField()) { if (reader.isEndGroup()) { break; } var field = reader.getFieldNumber(); switch (field) { case 1: var value = new bosdyn_api_header_pb.ResponseHeader; reader.readMessage(value,bosdyn_api_header_pb.ResponseHeader.deserializeBinaryFromReader); msg.setHeader(value); break; case 2: var value = /** @type {!proto.bosdyn.api.GetAuthTokenResponse.Status} */ (reader.readEnum()); msg.setStatus(value); break; case 3: var value = /** @type {string} */ (reader.readString()); msg.setToken(value); break; default: reader.skipField(); break; } } return msg; }; /** * Serializes the message to binary data (in protobuf wire format). * @return {!Uint8Array} */ proto.bosdyn.api.GetAuthTokenResponse.prototype.serializeBinary = function() { var writer = new jspb.BinaryWriter(); proto.bosdyn.api.GetAuthTokenResponse.serializeBinaryToWriter(this, writer); return writer.getResultBuffer(); }; /** * Serializes the given message to binary data (in protobuf wire * format), writing to the given BinaryWriter. * @param {!proto.bosdyn.api.GetAuthTokenResponse} message * @param {!jspb.BinaryWriter} writer * @suppress {unusedLocalVariables} f is only used for nested messages */ proto.bosdyn.api.GetAuthTokenResponse.serializeBinaryToWriter = function(message, writer) { var f = undefined; f = message.getHeader(); if (f != null) { writer.writeMessage( 1, f, bosdyn_api_header_pb.ResponseHeader.serializeBinaryToWriter ); } f = message.getStatus(); if (f !== 0.0) { writer.writeEnum( 2, f ); } f = message.getToken(); if (f.length > 0) { writer.writeString( 3, f ); } }; /** * @enum {number} */ proto.bosdyn.api.GetAuthTokenResponse.Status = { STATUS_UNKNOWN: 0, STATUS_OK: 1, STATUS_INVALID_LOGIN: 2, STATUS_INVALID_TOKEN: 3, STATUS_TEMPORARILY_LOCKED_OUT: 4, STATUS_INVALID_APPLICATION_TOKEN: 5, STATUS_EXPIRED_APPLICATION_TOKEN: 6 }; /** * optional ResponseHeader header = 1; * @return {?proto.bosdyn.api.ResponseHeader} */ proto.bosdyn.api.GetAuthTokenResponse.prototype.getHeader = function() { return /** @type{?proto.bosdyn.api.ResponseHeader} */ ( jspb.Message.getWrapperField(this, bosdyn_api_header_pb.ResponseHeader, 1)); }; /** * @param {?proto.bosdyn.api.ResponseHeader|undefined} value * @return {!proto.bosdyn.api.GetAuthTokenResponse} returns this */ proto.bosdyn.api.GetAuthTokenResponse.prototype.setHeader = function(value) { return jspb.Message.setWrapperField(this, 1, value); }; /** * Clears the message field making it undefined. * @return {!proto.bosdyn.api.GetAuthTokenResponse} returns this */ proto.bosdyn.api.GetAuthTokenResponse.prototype.clearHeader = function() { return this.setHeader(undefined); }; /** * Returns whether this field is set. * @return {boolean} */ proto.bosdyn.api.GetAuthTokenResponse.prototype.hasHeader = function() { return jspb.Message.getField(this, 1) != null; }; /** * optional Status status = 2; * @return {!proto.bosdyn.api.GetAuthTokenResponse.Status} */ proto.bosdyn.api.GetAuthTokenResponse.prototype.getStatus = function() { return /** @type {!proto.bosdyn.api.GetAuthTokenResponse.Status} */ (jspb.Message.getFieldWithDefault(this, 2, 0)); }; /** * @param {!proto.bosdyn.api.GetAuthTokenResponse.Status} value * @return {!proto.bosdyn.api.GetAuthTokenResponse} returns this */ proto.bosdyn.api.GetAuthTokenResponse.prototype.setStatus = function(value) { return jspb.Message.setProto3EnumField(this, 2, value); }; /** * optional string token = 3; * @return {string} */ proto.bosdyn.api.GetAuthTokenResponse.prototype.getToken = function() { return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 3, "")); }; /** * @param {string} value * @return {!proto.bosdyn.api.GetAuthTokenResponse} returns this */ proto.bosdyn.api.GetAuthTokenResponse.prototype.setToken = function(value) { return jspb.Message.setProto3StringField(this, 3, value); }; goog.object.extend(exports, proto.bosdyn.api);