Class: Uri

Uri(opt_dataopt)

new Uri(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:

Extends

  • jspb.Message

Classes

Authorization
Protocol
QueryParameter

Members

(static) Schema :number

Type:
  • number
Properties:
Name Type Description
UNDEFINED number
HTTP number
HTTPS number
FTP number
MAILTO number
FILE number
DATA number
IRC number
RTP number
Source:

(static) displayName

Source:

Methods

addQuery(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.spine.net.Uri.QueryParameter}

Parameters:
Name Type Attributes Description
opt_value proto.spine.net.Uri.QueryParameter <optional>
opt_index number <optional>
Source:
Returns:
Type
proto.spine.net.Uri.QueryParameter

clearAuth() → (non-null) {proto.spine.net.Uri}

Clears the message field making it undefined.
Source:
Returns:
returns this
Type
proto.spine.net.Uri

clearProtocol() → (non-null) {proto.spine.net.Uri}

Clears the message field making it undefined.
Source:
Returns:
returns this
Type
proto.spine.net.Uri

clearQueryList() → (non-null) {proto.spine.net.Uri}

Clears the list making it empty but non-null.
Source:
Returns:
returns this
Type
proto.spine.net.Uri

getAuth() → (nullable) {proto.spine.net.Uri.Authorization}

optional Authorization auth = 2;
Source:
Returns:
Type
proto.spine.net.Uri.Authorization

getFragment() → {string}

optional string fragment = 7;
Source:
Returns:
Type
string

getHost() → {string}

optional string host = 3;
Source:
Returns:
Type
string

getPath() → {string}

optional string path = 5;
Source:
Returns:
Type
string

getPort() → {string}

optional string port = 4;
Source:
Returns:
Type
string

getProtocol() → (nullable) {proto.spine.net.Uri.Protocol}

optional Protocol protocol = 1;
Source:
Returns:
Type
proto.spine.net.Uri.Protocol

getQueryList() → (non-null) {Array.<!proto.spine.net.Uri.QueryParameter>}

repeated QueryParameter query = 6;
Source:
Returns:
Type
Array.<!proto.spine.net.Uri.QueryParameter>

hasAuth() → {boolean}

Returns whether this field is set.
Source:
Returns:
Type
boolean

hasProtocol() → {boolean}

Returns whether this field is set.
Source:
Returns:
Type
boolean

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

Serializes the message to binary data (in protobuf wire format).
Source:
Returns:
Type
Uint8Array

setAuth(value) → (non-null) {proto.spine.net.Uri}

Parameters:
Name Type Description
value proto.spine.net.Uri.Authorization | undefined
Source:
Returns:
returns this
Type
proto.spine.net.Uri

setFragment(value) → (non-null) {proto.spine.net.Uri}

Parameters:
Name Type Description
value string
Source:
Returns:
returns this
Type
proto.spine.net.Uri

setHost(value) → (non-null) {proto.spine.net.Uri}

Parameters:
Name Type Description
value string
Source:
Returns:
returns this
Type
proto.spine.net.Uri

setPath(value) → (non-null) {proto.spine.net.Uri}

Parameters:
Name Type Description
value string
Source:
Returns:
returns this
Type
proto.spine.net.Uri

setPort(value) → (non-null) {proto.spine.net.Uri}

Parameters:
Name Type Description
value string
Source:
Returns:
returns this
Type
proto.spine.net.Uri

setProtocol(value) → (non-null) {proto.spine.net.Uri}

Parameters:
Name Type Description
value proto.spine.net.Uri.Protocol | undefined
Source:
Returns:
returns this
Type
proto.spine.net.Uri

setQueryList(valuenon-null) → (non-null) {proto.spine.net.Uri}

Parameters:
Name Type Description
value Array.<!proto.spine.net.Uri.QueryParameter>
Source:
Returns:
returns this
Type
proto.spine.net.Uri

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:
Returns:
Type
Object

(static) deserializeBinary(bytes) → (non-null) {proto.spine.net.Uri}

Deserializes binary data (in protobuf wire format).
Parameters:
Name Type Description
bytes jspb.ByteSource The bytes to deserialize.
Source:
Returns:
Type
proto.spine.net.Uri

(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.spine.net.Uri}

Deserializes binary data (in protobuf wire format) from the given reader into the given message object.
Parameters:
Name Type Description
msg proto.spine.net.Uri The message object to deserialize into.
reader jspb.BinaryReader The BinaryReader to use.
Source:
Returns:
Type
proto.spine.net.Uri

(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.spine.net.Uri
writer jspb.BinaryWriter
Source:

(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.spine.net.Uri The msg instance to transform.
Source:
Returns:
Type
Object